DmcInputStreamIF (dark-matter 3.1.15 API)

All Known Implementing Classes:

DmcInputStream, DmcTraceableInputStream
```
public interface DmcInputStreamIF
```
The DmcInputStreamIF is used to isolate the Dark Matter Core functionality associated with serialization from particular Java IO libraries that aren't supported in all contexts e.g. Google Web Toolkit.
It also provides separation from the Dark Matter Schema mechanisms which, likewise, are not provided in all contexts. The schema related methods are required to allow for the deserialization of object reference attributes.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`int`	`available()`
`DmcAttribute<?>`	`getAttributeInstance()` Returns an instance of the appropriate DmcAttribute based on reading an attribute ID from the input stream.
`DmcAttribute<?>`	`getAttributeInstance(DmcAttributeInfo ai)` Returns an instance of the appropriate DmcAttribute based on the attribute info.
`DmcAttribute<?>`	`getAttributeInstance(Integer id)` Returns an instance of the appropriate DmcAttribute based on the attribute ID.
`DmcObject`	`getDMOInstance(DmcInputStreamIF dis)`
`DmcFilter`	`getFilterValueInstance()` Returns an instance of the appropriate container for a filter value.
`DmcObjectName`	`getNameValueInstance()` Returns an instance of the appropriate container for a name value.
`int`	`readAttributeCount()`
`int`	`readAttributeID()`
`boolean`	`readBoolean()`
`byte`	`readByte()`
`int`	`readBytes(byte[] b)`
`char`	`readChar()`
`double`	`readDouble()`
`float`	`readFloat()`
`int`	`readInt()`
`long`	`readLong()`
`short`	`readShort()`
`String`	`readUTF()`
`int`	`readValueCount()`
`void`	`resolveReferences(DmcTypeNamedObjectREF<?,?> attr)` Attempts to resolve the references in the specified attribute.

- Method Detail
  - available
```
int available()
       throws Exception
```
    Throws:
    
    Exception
  - readAttributeID
```
int readAttributeID()
             throws Exception
```
    Throws:
    
    Exception
  - readAttributeCount
```
int readAttributeCount()
                throws Exception
```
    Throws:
    
    Exception
  - readValueCount
```
int readValueCount()
            throws Exception
```
    Throws:
    
    Exception
  - readBoolean
```
boolean readBoolean()
             throws Exception
```
    Throws:
    
    Exception
  - readByte
```
byte readByte()
       throws Exception
```
    Throws:
    
    Exception
  - readBytes
```
int readBytes(byte[] b)
       throws Exception
```
    Throws:
    
    Exception
  - readChar
```
char readChar()
       throws Exception
```
    Throws:
    
    Exception
  - readDouble
```
double readDouble()
           throws Exception
```
    Throws:
    
    Exception
  - readFloat
```
float readFloat()
         throws Exception
```
    Throws:
    
    Exception
  - readInt
```
int readInt()
     throws Exception
```
    Throws:
    
    Exception
  - readLong
```
long readLong()
       throws Exception
```
    Throws:
    
    Exception
  - readShort
```
short readShort()
         throws Exception
```
    Throws:
    
    Exception
  - readUTF
```
String readUTF()
        throws Exception
```
    Throws:
    
    Exception
  - getDMOInstance
```
DmcObject getDMOInstance(DmcInputStreamIF dis)
                  throws Exception
```
    Parameters:
    
    dis - the input stream.
    
    Returns:
    
    an object from the input stream.
    
    Throws:
    
    Exception
  - getAttributeInstance
```
DmcAttribute<?> getAttributeInstance(DmcAttributeInfo ai)
                              throws Exception
```
    Returns an instance of the appropriate DmcAttribute based on the attribute info.
    
    Parameters:
    
    ai - The attribute info.
    
    Returns:
    
    A DmcAttribute.
    
    Throws:
    
    Exception
  - getAttributeInstance
```
DmcAttribute<?> getAttributeInstance(Integer id)
                              throws Exception
```
    Returns an instance of the appropriate DmcAttribute based on the attribute ID.
    
    Parameters:
    
    id - The attribute ID.
    
    Returns:
    
    an attribute container.
    
    Throws:
    
    Exception
  - getAttributeInstance
```
DmcAttribute<?> getAttributeInstance()
                              throws Exception
```
    Returns an instance of the appropriate DmcAttribute based on reading an attribute ID from the input stream.
    
    Returns:
    
    An attribute of the correct type.
    
    Throws:
    
    Exception
  - getNameValueInstance
```
DmcObjectName getNameValueInstance()
                            throws Exception
```
    Returns an instance of the appropriate container for a name value.
    
    Returns:
    
    a name.
    
    Throws:
    
    Exception
  - getFilterValueInstance
```
DmcFilter getFilterValueInstance()
                          throws Exception
```
    Returns an instance of the appropriate container for a filter value.
    
    Returns:
    
    a filter.
    
    Throws:
    
    Exception
  - resolveReferences
```
void resolveReferences(DmcTypeNamedObjectREF<?,?> attr)
                throws Exception
```
    Attempts to resolve the references in the specified attribute. If the attribute isn't an object reference, nothing happens.
    
    Parameters:
    
    attr - The object reference attribute to be resolved.
    
    Throws:
    
    Exception

Interface DmcInputStreamIF

Method Summary

Method Detail

available

readAttributeID

readAttributeCount

readValueCount

readBoolean

readByte

readBytes

readChar

readDouble

readFloat

readInt

readLong

readShort

readUTF

getDMOInstance

getAttributeInstance

getAttributeInstance

getAttributeInstance

getNameValueInstance

getFilterValueInstance

resolveReferences