org.apache.camel.impl

Class StringDataFormat

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.StringDataFormat

All Implemented Interfaces:

Service, ShutdownableService, DataFormat, DataFormatName, StatefulService, SuspendableService

public class StringDataFormat
extends ServiceSupport
implements DataFormat, DataFormatName

The text based data format supporting charset encoding.

Version:

Field Summary

Fields inherited from class org.apache.camel.support.ServiceSupport

shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
StringDataFormat()
StringDataFormat(String charset)

Method Summary

Modifier and Type	Method and Description
protected void	doStart() Implementations override this method to support customized start/stop.
protected void	doStop() Implementations override this method to support customized start/stop.
String	getCharset()
String	getDataFormatName() The name of the data format
void	marshal(Exchange exchange, Object graph, OutputStream stream) Marshals the object to the given Stream.
void	setCharset(String charset)
Object	unmarshal(Exchange exchange, InputStream stream) Unmarshals the given stream into an object.

Methods inherited from class org.apache.camel.support.ServiceSupport

doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StringDataFormat

public StringDataFormat()

StringDataFormat

public StringDataFormat(String charset)

Method Detail

getDataFormatName

public String getDataFormatName()

Description copied from interface: DataFormatName

The name of the data format

Specified by:

getDataFormatName in interface DataFormatName

getCharset

public String getCharset()

setCharset

public void setCharset(String charset)

marshal

public void marshal(Exchange exchange,
                    Object graph,
                    OutputStream stream)
             throws IOException

Description copied from interface: DataFormat

Marshals the object to the given Stream.

Specified by:

marshal in interface DataFormat

Parameters:

exchange - the current exchange

graph - the object to be marshalled

stream - the output stream to write the marshalled result to

Throws:

IOException

unmarshal

public Object unmarshal(Exchange exchange,
                        InputStream stream)
                 throws IOException

Description copied from interface: DataFormat

Unmarshals the given stream into an object.

Notice: The result is set as body on the exchange OUT message. It is possible to mutate the OUT message provided in the given exchange parameter. For instance adding headers to the OUT message will be preserved.

It's also legal to return the same passed exchange as is but also a Message object as well which will be used as the OUT message of exchange.

Specified by:

unmarshal in interface DataFormat

Parameters:

exchange - the current exchange

stream - the input stream with the object to be unmarshalled

Returns:

the unmarshalled object

Throws:

IOException

doStart

protected void doStart()
                throws Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: See ServiceSupport.doStop() for more details.

Specified by:

doStart in class ServiceSupport

Throws:

Exception

See Also:

ServiceSupport.doStop()

doStop

protected void doStop()
               throws Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: Camel will invoke this ServiceSupport.doStop() method when the service is being stopped. This method will also be invoked if the service is still in uninitialized state (eg has not been started). The method is always called to allow the service to do custom logic when the service is being stopped, such as when CamelContext is shutting down.

Specified by:

doStop in class ServiceSupport

Throws:

Exception

See Also:

ServiceSupport.doStart()