org.jboss.dmr.stream

Interface ModelWriter

All Superinterfaces:

java.lang.AutoCloseable, java.io.Flushable

public interface ModelWriter
extends java.io.Flushable, java.lang.AutoCloseable

DMR writer. Instances of this interface are not thread safe.

Author:

Richard Opalka

See Also:

ModelStreamFactory

Method Summary

Modifier and Type	Method and Description
void	close() Free resources associated with this writer.
void	flush() Writes all cached data.
ModelWriter	writeBigDecimal(java.math.BigDecimal data) Writes DMR number.
ModelWriter	writeBigInteger(java.math.BigInteger data) Writes DMR number.
ModelWriter	writeBoolean(boolean data) Writes DMR true or false token.
ModelWriter	writeBytes(byte[] data) Writes DMR bytes.
ModelWriter	writeDouble(double data) Writes DMR number.
ModelWriter	writeExpression(java.lang.String data) Writes DMR expression.
ModelWriter	writeInt(int data) Writes DMR number.
ModelWriter	writeListEnd() Writes DMR list end token.
ModelWriter	writeListStart() Writes DMR list start token.
ModelWriter	writeLong(long data) Writes DMR number.
ModelWriter	writeObjectEnd() Writes DMR object end token.
ModelWriter	writeObjectStart() Writes DMR object start token.
ModelWriter	writePropertyEnd() Writes DMR property end token.
ModelWriter	writePropertyStart() Writes DMR property start token.
ModelWriter	writeString(java.lang.String data) Writes DMR string.
ModelWriter	writeType(ModelType data) Writes DMR type.
ModelWriter	writeUndefined() Writes DMR undefined token.

Method Detail

writeObjectStart

ModelWriter writeObjectStart()
                      throws java.io.IOException,
                             ModelException

Writes DMR object start token.

Returns:

this writer instance

Throws:

java.io.IOException - if some I/O error occurs

ModelException - if invalid DMR write attempt is detected

writeObjectEnd

ModelWriter writeObjectEnd()
                    throws java.io.IOException,
                           ModelException

Writes DMR object end token.

Returns:

this writer instance

Throws:

java.io.IOException - if some I/O error occurs

ModelException - if invalid DMR write attempt is detected

writePropertyStart

ModelWriter writePropertyStart()
                        throws java.io.IOException,
                               ModelException

Writes DMR property start token.

Returns:

this writer instance

Throws:

java.io.IOException - if some I/O error occurs

ModelException - if invalid DMR write attempt is detected

writePropertyEnd

ModelWriter writePropertyEnd()
                      throws java.io.IOException,
                             ModelException

Writes DMR property end token.

Returns:

this writer instance

Throws:

java.io.IOException - if some I/O error occurs

ModelException - if invalid DMR write attempt is detected

writeListStart

ModelWriter writeListStart()
                    throws java.io.IOException,
                           ModelException

Writes DMR list start token.

Returns:

this writer instance

Throws:

java.io.IOException - if some I/O error occurs

ModelException - if invalid DMR write attempt is detected

writeListEnd

ModelWriter writeListEnd()
                  throws java.io.IOException,
                         ModelException

Writes DMR list end token.

Returns:

this writer instance

Throws:

java.io.IOException - if some I/O error occurs

ModelException - if invalid DMR write attempt is detected

writeUndefined

ModelWriter writeUndefined()
                    throws java.io.IOException,
                           ModelException

Writes DMR undefined token.

Returns:

this writer instance

Throws:

java.io.IOException - if some I/O error occurs

ModelException - if invalid DMR write attempt is detected

writeString

ModelWriter writeString(java.lang.String data)
                 throws java.io.IOException,
                        ModelException

Writes DMR string.

Parameters:

data - to encode

Returns:

this writer instance

Throws:

java.io.IOException - if some I/O error occurs

ModelException - if invalid DMR write attempt is detected

writeExpression

ModelWriter writeExpression(java.lang.String data)
                     throws java.io.IOException,
                            ModelException

Writes DMR expression.

Parameters:

data - to encode

Returns:

this writer instance

Throws:

java.io.IOException - if some I/O error occurs

ModelException - if invalid DMR write attempt is detected

writeBytes

ModelWriter writeBytes(byte[] data)
                throws java.io.IOException,
                       ModelException

Writes DMR bytes.

Parameters:

data - to encode

Returns:

this writer instance

Throws:

java.io.IOException - if some I/O error occurs

ModelException - if invalid DMR write attempt is detected

writeBoolean

ModelWriter writeBoolean(boolean data)
                  throws java.io.IOException,
                         ModelException

Writes DMR true or false token.

Parameters:

data - to encode

Returns:

this writer instance

Throws:

java.io.IOException - if some I/O error occurs

ModelException - if invalid DMR write attempt is detected

writeInt

ModelWriter writeInt(int data)
              throws java.io.IOException,
                     ModelException

Writes DMR number.

Parameters:

data - to encode

Returns:

this writer instance

Throws:

java.io.IOException - if some I/O error occurs

ModelException - if invalid DMR write attempt is detected

writeLong

ModelWriter writeLong(long data)
               throws java.io.IOException,
                      ModelException

Writes DMR number.

Parameters:

data - to encode

Returns:

this writer instance

Throws:

java.io.IOException - if some I/O error occurs

ModelException - if invalid DMR write attempt is detected

writeBigInteger

ModelWriter writeBigInteger(java.math.BigInteger data)
                     throws java.io.IOException,
                            ModelException

Writes DMR number.

Parameters:

data - to encode

Returns:

this writer instance

Throws:

java.io.IOException - if some I/O error occurs

ModelException - if invalid DMR write attempt is detected

writeBigDecimal

ModelWriter writeBigDecimal(java.math.BigDecimal data)
                     throws java.io.IOException,
                            ModelException

Writes DMR number.

Parameters:

data - to encode

Returns:

this writer instance

Throws:

java.io.IOException - if some I/O error occurs

ModelException - if invalid DMR write attempt is detected

writeDouble

ModelWriter writeDouble(double data)
                 throws java.io.IOException,
                        ModelException

Writes DMR number.

Parameters:

data - to encode

Returns:

this writer instance

Throws:

java.io.IOException - if some I/O error occurs

ModelException - if invalid DMR write attempt is detected

writeType

ModelWriter writeType(ModelType data)
               throws java.io.IOException,
                      ModelException

Writes DMR type.

Parameters:

data - to encode

Returns:

this writer instance

Throws:

java.io.IOException - if some I/O error occurs

ModelException - if invalid DMR write attempt is detected

flush

void flush()
    throws java.io.IOException

Writes all cached data.

Specified by:

flush in interface java.io.Flushable

Throws:

java.io.IOException - if some I/O error occurs

close

void close()
    throws java.io.IOException,
           ModelException

Free resources associated with this writer. Never closes underlying input stream or writer.

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException - if some I/O error occurs

ModelException - if invalid DMR write attempt is detected