Package org.jboss.marshalling.util

Class ReadField

java.lang.Object
org.jboss.marshalling.util.ReadField
All Implemented Interfaces:
Comparable<ReadField>
Direct Known Subclasses:
BooleanReadField, ByteReadField, CharReadField, DoubleReadField, FloatReadField, IntReadField, LongReadField, ObjectReadField, ShortReadField
public abstract class ReadField extends Object implements Comparable<ReadField>
Base class for a field which was read from the data stream.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    ReadField(String name, boolean defaulted)
    Construct a new instance.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    compareTo(ReadField o)
    Compare this field with another on the basis of its name.
    boolean
    getBoolean()
    Get the boolean value of this field.
    byte
    getByte()
    Get the byte value of this field.
    char
    getChar()
    Get the character value of this field.
    double
    getDouble()
    Get the double value of this field.
    float
    getFloat()
    Get the float value of this field.
    int
    getInt()
    Get the integer value of this field.
    abstract Kind
    getKind()
    Get the kind of field represented by this object.
    long
    getLong()
    Get the long value of this field.
    String
    getName()
    Get the field name.
    Object
    getObject()
    Get the object value of this field.
    short
    getShort()
    Get the short value of this field.
    boolean
    isDefaulted()
    Determine whether this field was defaulted.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ReadField

      protected ReadField(String name, boolean defaulted)
      Construct a new instance.
      Parameters:
      name - the field name
      defaulted - true if the field's value was defaulted, false otherwise

  • Method Details

    • getKind

      public abstract Kind getKind()
      Get the kind of field represented by this object.
      Returns:
      the kind of field represented by this object

    • getName

      public String getName()
      Get the field name.
      Returns:
      the field name

    • isDefaulted

      public boolean isDefaulted()
      Determine whether this field was defaulted.
      Returns:
      true if this field value was defaulted, false otherwise

    • getBoolean

      public boolean getBoolean() throws IOException
      Get the boolean value of this field.
      Returns:
      the boolean value of this field
      Throws:
      IOException - if the value cannot be read

    • getChar

      public char getChar() throws IOException
      Get the character value of this field.
      Returns:
      the character value of this field
      Throws:
      IOException - if the value cannot be read

    • getFloat

      public float getFloat() throws IOException
      Get the float value of this field.
      Returns:
      the float value of this field
      Throws:
      IOException - if the value cannot be read

    • getDouble

      public double getDouble() throws IOException
      Get the double value of this field.
      Returns:
      the double value of this field
      Throws:
      IOException - if the value cannot be read

    • getByte

      public byte getByte() throws IOException
      Get the byte value of this field.
      Returns:
      the byte value of this field
      Throws:
      IOException - if the value cannot be read

    • getShort

      public short getShort() throws IOException
      Get the short value of this field.
      Returns:
      the short value of this field
      Throws:
      IOException - if the value cannot be read

    • getInt

      public int getInt() throws IOException
      Get the integer value of this field.
      Returns:
      the integer value of this field
      Throws:
      IOException - if the value cannot be read

    • getLong

      public long getLong() throws IOException
      Get the long value of this field.
      Returns:
      the long value of this field
      Throws:
      IOException - if the value cannot be read

    • getObject

      public Object getObject() throws IOException
      Get the object value of this field.
      Returns:
      the object value of this field
      Throws:
      IOException - if the value cannot be read

    • compareTo

      public int compareTo(ReadField o)
      Compare this field with another on the basis of its name.
      Specified by:
      compareTo in interface Comparable<ReadField>
      Parameters:
      o - the other field object
      Returns:
      the sort result based on the name of this field and the given field