ModelReader (JBoss Dynamic Model Representation 1.6.0.Beta1 API)

All Superinterfaces:

java.lang.AutoCloseable
```
public interface ModelReader
extends java.lang.AutoCloseable
```
DMR reader. Instances of this interface are not thread safe.

Author:

Richard Opalka

See Also:

ModelStreamFactory

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`close()` Free resources associated with this reader.
`java.math.BigDecimal`	`getBigDecimal()` Converts available context data to `big decimal` instance.
`java.math.BigInteger`	`getBigInteger()` Converts available context data to `big integer` instance.
`boolean`	`getBoolean()` Converts available context data to `boolean`.
`byte[]`	`getBytes()` Converts available context data to `bytes`.
`double`	`getDouble()` Converts available context data to `double`.
`java.lang.String`	`getExpression()` Converts available context data to `expression`.
`int`	`getInt()` Converts available context data to `int`.
`long`	`getLong()` Converts available context data to `long`.
`java.lang.String`	`getString()` Converts available context data to `String`.
`ModelType`	`getType()` Converts available context data to `model type`.
`boolean`	`hasNext()` Detects if there is next DMR parsing event available.
`boolean`	`isBigDecimal()` Returns `true` if current DMR parsing event is DMR `big decimal`, `false` otherwise.
`boolean`	`isBigInteger()` Returns `true` if current DMR parsing event is DMR `big integer`, `false` otherwise.
`boolean`	`isBoolean()` Returns `true` if current DMR parsing event is DMR `boolean` token, `false` otherwise.
`boolean`	`isBytes()` Returns `true` if current DMR parsing event is DMR `bytes`, `false` otherwise.
`boolean`	`isDouble()` Returns `true` if current DMR parsing event is DMR `double`, `false` otherwise.
`boolean`	`isExpression()` Returns `true` if current DMR parsing event is DMR `expression`, `false` otherwise.
`boolean`	`isInt()` Returns `true` if current DMR parsing event is DMR `int`, `false` otherwise.
`boolean`	`isListEnd()` Returns `true` if current DMR parsing event is DMR `list end` token, `false` otherwise.
`boolean`	`isListStart()` Returns `true` if current DMR parsing event is DMR `list start` token, `false` otherwise.
`boolean`	`isLong()` Returns `true` if current DMR parsing event is DMR `long`, `false` otherwise.
`boolean`	`isObjectEnd()` Returns `true` if current DMR parsing event is DMR `object end` token, `false` otherwise.
`boolean`	`isObjectStart()` Returns `true` if current DMR parsing event is DMR `object start` token, `false` otherwise.
`boolean`	`isPropertyEnd()` Returns `true` if current DMR parsing event is DMR `property end` token, `false` otherwise.
`boolean`	`isPropertyStart()` Returns `true` if current DMR parsing event is DMR `property start` token, `false` otherwise.
`boolean`	`isString()` Returns `true` if current DMR parsing event is DMR `string`, `false` otherwise.
`boolean`	`isType()` Returns `true` if current DMR parsing event is DMR `type`, `false` otherwise.
`boolean`	`isUndefined()` Returns `true` if current DMR parsing event is DMR `undefined` token, `false` otherwise.
`ModelEvent`	`next()` Returns next DMR parsing event.

- Method Detail
  - hasNext
```
boolean hasNext()
```
    Detects if there is next DMR parsing event available. Users should call this method before calling next() method.
    
    Returns:
    
    true if there are more DMR parsing events, false otherwise
  - next
```
ModelEvent next()
         throws java.io.IOException,
                ModelException
```
    Returns next DMR parsing event. Users should call hasNext() before calling this method.
    
    Returns:
    
    ModelEvent next event
    
    Throws:
    
    java.io.IOException - if some I/O error occurs
    
    ModelException - if wrong DMR is detected
  - isObjectStart
```
boolean isObjectStart()
```
    Returns true if current DMR parsing event is DMR object start token, false otherwise. Users have to call next() before calling this method.
    
    Returns:
    
    true if the parsing cursor position points to DMR object start token, false otherwise
  - isObjectEnd
```
boolean isObjectEnd()
```
    Returns true if current DMR parsing event is DMR object end token, false otherwise. Users have to call next() before calling this method.
    
    Returns:
    
    true if the parsing cursor position points to DMR object end token, false otherwise
  - isPropertyStart
```
boolean isPropertyStart()
```
    Returns true if current DMR parsing event is DMR property start token, false otherwise. Users have to call next() before calling this method.
    
    Returns:
    
    true if the parsing cursor position points to DMR property start token, false otherwise
  - isPropertyEnd
```
boolean isPropertyEnd()
```
    Returns true if current DMR parsing event is DMR property end token, false otherwise. Users have to call next() before calling this method.
    
    Returns:
    
    true if the parsing cursor position points to DMR property end token, false otherwise
  - isListStart
```
boolean isListStart()
```
    Returns true if current DMR parsing event is DMR list start token, false otherwise. Users have to call next() before calling this method.
    
    Returns:
    
    true if the parsing cursor position points to DMR list start token, false otherwise
  - isListEnd
```
boolean isListEnd()
```
    Returns true if current DMR parsing event is DMR list end token, false otherwise. Users have to call next() before calling this method.
    
    Returns:
    
    true if the parsing cursor position points to DMR list end token, false otherwise
  - isUndefined
```
boolean isUndefined()
```
    Returns true if current DMR parsing event is DMR undefined token, false otherwise. Users have to call next() before calling this method.
    
    Returns:
    
    true if the parsing cursor position points to DMR undefined token, false otherwise
  - isType
```
boolean isType()
```
    Returns true if current DMR parsing event is DMR type, false otherwise. Users have to call next() before calling this method.
    
    Returns:
    
    true if the parsing cursor position points to DMR type, false otherwise
  - getType
```
ModelType getType()
```
    Converts available context data to model type. Users have to call next() and should call isType() before calling this method.
    
    Returns:
    
    type the parsing cursor is pointing to
    
    Throws:
    
    java.lang.IllegalStateException - if cursor isn't pointing to DMR type
  - isString
```
boolean isString()
```
    Returns true if current DMR parsing event is DMR string, false otherwise. Users have to call next() before calling this method.
    
    Returns:
    
    true if the parsing cursor position points to DMR string, false otherwise
  - getString
```
java.lang.String getString()
```
    Converts available context data to String. Users have to call next() and should call isString() before calling this method.
    
    Returns:
    
    string the parsing cursor is pointing to
    
    Throws:
    
    java.lang.IllegalStateException - if cursor isn't pointing to DMR String
  - isExpression
```
boolean isExpression()
```
    Returns true if current DMR parsing event is DMR expression, false otherwise. Users have to call next() before calling this method.
    
    Returns:
    
    true if the parsing cursor position points to DMR expression, false otherwise
  - getExpression
```
java.lang.String getExpression()
```
    Converts available context data to expression. Users have to call next() and should call isExpression() before calling this method.
    
    Returns:
    
    expression the parsing cursor is pointing to
    
    Throws:
    
    java.lang.IllegalStateException - if cursor isn't pointing to DMR expression
  - isBytes
```
boolean isBytes()
```
    Returns true if current DMR parsing event is DMR bytes, false otherwise. Users have to call next() before calling this method.
    
    Returns:
    
    true if the parsing cursor position points to DMR bytes, false otherwise
  - getBytes
```
byte[] getBytes()
```
    Converts available context data to bytes. Users have to call next() and should call isBytes() before calling this method.
    
    Returns:
    
    bytes the parsing cursor is pointing to
    
    Throws:
    
    java.lang.IllegalStateException - if cursor isn't pointing to DMR Bytes
  - isBoolean
```
boolean isBoolean()
```
    Returns true if current DMR parsing event is DMR boolean token, false otherwise. Users have to call next() before calling this method.
    
    Returns:
    
    true if the parsing cursor points to DMR boolean tokens, false otherwise
  - getBoolean
```
boolean getBoolean()
```
    Converts available context data to boolean. Users have to call next() and should call isBoolean() before calling this method.
    
    Returns:
    
    boolean value the parsing cursor is pointing to
    
    Throws:
    
    java.lang.IllegalStateException - if cursor isn't pointing to DMR boolean token
  - isInt
```
boolean isInt()
```
    Returns true if current DMR parsing event is DMR int, false otherwise. Users have to call next() before calling this method.
    
    Returns:
    
    true if the parsing cursor points to DMR int, false otherwise
  - getInt
```
int getInt()
```
    Converts available context data to int. Users have to call next() and should call isInt() before calling this method.
    
    Returns:
    
    int value the parsing cursor is pointing to
  - isLong
```
boolean isLong()
```
    Returns true if current DMR parsing event is DMR long, false otherwise. Users have to call next() before calling this method.
    
    Returns:
    
    true if the parsing cursor points to DMR int, false otherwise
  - getLong
```
long getLong()
```
    Converts available context data to long. Users have to call next() and should call isLong() before calling this method.
    
    Returns:
    
    long value the parsing cursor is pointing to
  - isDouble
```
boolean isDouble()
```
    Returns true if current DMR parsing event is DMR double, false otherwise. Users have to call next() before calling this method.
    
    Returns:
    
    true if the parsing cursor points to DMR double, false otherwise
  - getDouble
```
double getDouble()
```
    Converts available context data to double. Users have to call next() and should call isDouble() before calling this method.
    
    Returns:
    
    double value the parsing cursor is pointing to
  - isBigInteger
```
boolean isBigInteger()
```
    Returns true if current DMR parsing event is DMR big integer, false otherwise. Users have to call next() before calling this method.
    
    Returns:
    
    true if the parsing cursor points to DMR big integer, false otherwise
  - getBigInteger
```
java.math.BigInteger getBigInteger()
```
    Converts available context data to big integer instance. Users have to call next() and should call isBigInteger() before calling this method.
    
    Returns:
    
    big integer value the parsing cursor is pointing to
  - isBigDecimal
```
boolean isBigDecimal()
```
    Returns true if current DMR parsing event is DMR big decimal, false otherwise. Users have to call next() before calling this method.
    
    Returns:
    
    true if the parsing cursor points to DMR big decimal, false otherwise
  - getBigDecimal
```
java.math.BigDecimal getBigDecimal()
```
    Converts available context data to big decimal instance. Users have to call next() and should call isBigDecimal() before calling this method.
    
    Returns:
    
    big decimal value the parsing cursor is pointing to
  - close
```
void close()
    throws ModelException
```
    Free resources associated with this reader. Never closes underlying output stream or reader.
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Throws:
    
    ModelException - if attempting to close this reader before reaching EOF.

Interface ModelReader

Method Summary

Method Detail

hasNext

next

isObjectStart

isObjectEnd

isPropertyStart

isPropertyEnd

isListStart

isListEnd

isUndefined

isType

getType

isString

getString

isExpression

getExpression

isBytes

getBytes

isBoolean

getBoolean

isInt

getInt

isLong

getLong

isDouble

getDouble

isBigInteger

getBigInteger

isBigDecimal

getBigDecimal

close