J-Sim v1.2.1-p7 API

drcl.data
Class Struct

java.lang.Object
  extended bydrcl.DrclObj
      extended bydrcl.data.Struct
All Implemented Interfaces:
java.lang.Cloneable, ObjectDuplicable, java.io.Serializable
Direct Known Subclasses:
UniversalStruct

public abstract class Struct
extends DrclObj

The class which emulates the "struct" language construct in C. Each field in the struct is referenced by its index, starting from 0. Subclasses must implement getNumFields() and getAllFields() and would implement different setter/getter methods based on the struct format.

See Also:
Serialized Form

Field Summary
protected static java.lang.String DEFAULT_SEPARATOR
           
protected  java.lang.String name
           
 
Constructor Summary
Struct()
           
 
Method Summary
 void duplicate(java.lang.Object source_)
          opies the content of the source_ object to this object.
 boolean equals(java.lang.Object obj_)
           
 java.lang.Object get(int index_)
           
 java.lang.Object get(java.lang.String name_)
           
abstract  java.lang.Object[] getAllFields()
           
 boolean getBoolean(int index_)
           
 boolean getBoolean(java.lang.String name_)
           
 double getDouble(int index_)
           
 double getDouble(java.lang.String name_)
           
 java.lang.String getFieldName(int index_)
           
 java.lang.String[] getFieldNames()
           
 int getInt(int index_)
           
 int getInt(java.lang.String name_)
           
 long getLong(int index_)
           
 long getLong(java.lang.String name_)
           
 java.lang.String getName()
           
abstract  int getNumFields()
           
 int indexOf(java.lang.String fieldName_)
           
 boolean isNull(int index_)
           
 boolean isNull(java.lang.String name_)
           
 void set(int index_, java.lang.Object value_)
           
 void set(java.lang.String name_, java.lang.Object value_)
           
 void setBoolean(int index_, boolean value_)
           
 void setBoolean(java.lang.String name_, boolean value_)
           
 void setDouble(int index_, double value_)
           
 void setDouble(java.lang.String name_, double value_)
           
 void setInt(int index_, int value_)
           
 void setInt(java.lang.String name_, int value_)
           
 void setLong(int index_, long value_)
           
 void setLong(java.lang.String name_, long value_)
           
protected  void setName(java.lang.String name_)
           
 Struct subStruct(int beginIndex_)
           
 Struct subStruct(int beginIndex_, int endIndex_)
           
 java.lang.String toString()
           
 java.lang.String toString(int startIndex_)
           
 java.lang.String toString(int startIndex_, int endIndex_)
           
 java.lang.String toString(int startIndex_, int endIndex_, java.lang.String separator_)
          Prints out the content of this struct.
 java.lang.String toString(int startIndex_, java.lang.String separator_)
           
 java.lang.String toString(java.lang.String separator_)
           
 
Methods inherited from class drcl.DrclObj
clone
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

name

protected java.lang.String name

DEFAULT_SEPARATOR

protected static final java.lang.String DEFAULT_SEPARATOR
See Also:
Constant Field Values
Constructor Detail

Struct

public Struct()
Method Detail

setName

protected void setName(java.lang.String name_)

getName

public java.lang.String getName()

getNumFields

public abstract int getNumFields()

getAllFields

public abstract java.lang.Object[] getAllFields()

indexOf

public int indexOf(java.lang.String fieldName_)

set

public void set(int index_,
                java.lang.Object value_)

get

public java.lang.Object get(int index_)

isNull

public boolean isNull(int index_)

setInt

public void setInt(int index_,
                   int value_)

getInt

public int getInt(int index_)

setLong

public void setLong(int index_,
                    long value_)

getLong

public long getLong(int index_)

setDouble

public void setDouble(int index_,
                      double value_)

getDouble

public double getDouble(int index_)

setBoolean

public void setBoolean(int index_,
                       boolean value_)

getBoolean

public boolean getBoolean(int index_)

getFieldNames

public java.lang.String[] getFieldNames()

getFieldName

public java.lang.String getFieldName(int index_)

duplicate

public void duplicate(java.lang.Object source_)
Description copied from class: DrclObj
opies the content of the source_ object to this object. he subclass must implement this method to realize DrclObj.clone().

Specified by:
duplicate in interface ObjectDuplicable
Overrides:
duplicate in class DrclObj

toString

public java.lang.String toString()
Overrides:
toString in class DrclObj

toString

public java.lang.String toString(java.lang.String separator_)

toString

public java.lang.String toString(int startIndex_)

toString

public java.lang.String toString(int startIndex_,
                                 java.lang.String separator_)

toString

public java.lang.String toString(int startIndex_,
                                 int endIndex_)
Parameters:
endIndex_ - exclusive; may be negative to indicate the relative index from the end.

toString

public java.lang.String toString(int startIndex_,
                                 int endIndex_,
                                 java.lang.String separator_)
Prints out the content of this struct. Subclasses may override this method to customize for all toString(...) methods of the Struct.

Parameters:
endIndex_ - exclusive; may be zero or negative to indicate the relative index from the end.

equals

public boolean equals(java.lang.Object obj_)

subStruct

public Struct subStruct(int beginIndex_,
                        int endIndex_)
Parameters:
beginIndex_ - inclusive.
endIndex_ - exclusive.

subStruct

public Struct subStruct(int beginIndex_)
Parameters:
beginIndex_ - inclusive.

setInt

public void setInt(java.lang.String name_,
                   int value_)

getInt

public int getInt(java.lang.String name_)
           throws java.lang.Exception
Throws:
java.lang.Exception

setLong

public void setLong(java.lang.String name_,
                    long value_)

getLong

public long getLong(java.lang.String name_)
             throws java.lang.Exception
Throws:
java.lang.Exception

setDouble

public void setDouble(java.lang.String name_,
                      double value_)

getDouble

public double getDouble(java.lang.String name_)
                 throws java.lang.Exception
Throws:
java.lang.Exception

setBoolean

public void setBoolean(java.lang.String name_,
                       boolean value_)

getBoolean

public boolean getBoolean(java.lang.String name_)
                   throws java.lang.Exception
Throws:
java.lang.Exception

set

public void set(java.lang.String name_,
                java.lang.Object value_)

get

public java.lang.Object get(java.lang.String name_)

isNull

public boolean isNull(java.lang.String name_)

J-Sim v1.2.1-p7 API

Copyright © 1998-2003 Distributed Real-time Computing Lab (DRCL). All Rights Reserved.     ~ To J-Sim Home ~