JBoss Marshalling API 2.1.4.Final · org.jboss.marshalling.reflect.SerializableField

Modifier and Type	Class and Description
pack-priv static class	SerializableField.RecordComponent A record component, which has a name, type and index.

Modifier and Type	Field and Description
private final Field	field
private final long	fieldOffset
private final Kind	kind
private final String	name
private final int	recordComponentIndex
private final Class<?>	type
pack-priv static final Unsafe	unsafe
private final boolean	unshared

Access	Constructor and Description
public	SerializableField(Class<?> type, String name, boolean unshared)
pack-priv	SerializableField(Class<?> type, String name, boolean unshared, final Field field, SerializableField.RecordComponent recordComponent)

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: the value of the field getBoolean(Object the object instance (must not be `null`, must be of the correct type) instance) Get the boolean value of this field on the given object instance.
public byte	Returns: the value of the field getByte(Object the object instance (must not be `null`, must be of the correct type) instance) Get the byte value of this field on the given object instance.
public char	Returns: the value of the field getChar(Object the object instance (must not be `null`, must be of the correct type) instance) Get the char value of this field on the given object instance.
public double	Returns: the value of the field getDouble(Object the object instance (must not be `null`, must be of the correct type) instance) Get the double value of this field on the given object instance.
public Field	Returns: the reflection field getField() Deprecated As of Java 9, accessible fields are generally disallowed; use the `#setXXX(Object,value)` methods instead. Get the reflection `Field` for this serializable field.
public float	Returns: the value of the field getFloat(Object the object instance (must not be `null`, must be of the correct type) instance) Get the float value of this field on the given object instance.
public int	Returns: the value of the field getInt(Object the object instance (must not be `null`, must be of the correct type) instance) Get the integer value of this field on the given object instance.
public Kind	Returns: the kind getKind() Get the kind of field.
public long	Returns: the value of the field getLong(Object the object instance (must not be `null`, must be of the correct type) instance) Get the long value of this field on the given object instance.
public String	Returns: the name getName() Get the name of the field.
public Object	Returns: the value of the field getObject(Object the object instance (must not be `null`, must be of the correct type) instance) Get the object value of this field on the given object instance.
public int	Returns: The record component index or -1 getRecordComponentIndex() Getter for the record component index.
public Object	Returns: The record component value for this obj getRecordComponentValue(Object The object to obtain the record component value obj) Getter for the record component value.
public short	Returns: the value of the field getShort(Object the object instance (must not be `null`, must be of the correct type) instance) Get the short value of this field on the given object instance.
public Class<?>	Returns: the field type getType() Get the field type.
public boolean	Returns: `true` if this object may be used to get or set an object field value, `false` otherwise isAccessible() Determine if this object may be used to get or set an object field value.
public boolean	Returns: `true` if the field is unshared isUnshared() Determine whether this field is marked as "unshared".
public void	readFrom(Object the instance instance, ObjectInput the source stream input) Read the field value from the stream.
public void	setBoolean(Object the object instance (must not be `null`, must be of the correct type) instance, boolean the value to set value) Set the boolean value of this field on the given object instance.
public void	setByte(Object the object instance (must not be `null`, must be of the correct type) instance, byte the value to set value) Set the byte value of this field on the given object instance.
public void	setChar(Object the object instance (must not be `null`, must be of the correct type) instance, char the value to set value) Set the char value of this field on the given object instance.
public void	setDouble(Object the object instance (must not be `null`, must be of the correct type) instance, double the value to set value) Set the double value of this field on the given object instance.
public void	setFloat(Object the object instance (must not be `null`, must be of the correct type) instance, float the value to set value) Set the float value of this field on the given object instance.
public void	setInt(Object the object instance (must not be `null`, must be of the correct type) instance, int the value to set value) Set the integer value of this field on the given object instance.
public void	setLong(Object the object instance (must not be `null`, must be of the correct type) instance, long the value to set value) Set the long value of this field on the given object instance.
public void	setObject(Object the object instance (must not be `null`, must be of the correct type) instance, Object the value to set value) Set the object value of this field on the given object instance.
public void	setShort(Object the object instance (must not be `null`, must be of the correct type) instance, short the value to set value) Set the short value of this field on the given object instance.
public void	writeTo(Object instance, ObjectOutput output)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

field	back to summary
private final Field field

fieldOffset	back to summary
private final long fieldOffset

kind	back to summary
private final Kind kind

name	back to summary
private final String name

recordComponentIndex	back to summary
private final int recordComponentIndex

type	back to summary
private final Class<?> type

unsafe	back to summary
pack-priv static final Unsafe unsafe

unshared	back to summary
private final boolean unshared

SerializableField	back to summary
public SerializableField(Class<?> type, String name, boolean unshared)

SerializableField	back to summary
pack-priv SerializableField(Class<?> type, String name, boolean unshared, final Field field, SerializableField.RecordComponent recordComponent)

Method Detail

getBoolean back to summary

getBoolean	back to summary
public boolean getBoolean(Object instance) throws ClassCastException, IllegalArgumentException Get the boolean value of this field on the given object instance. Parameters instance:Object the object instance (must not be `null`, must be of the correct type) Returns:boolean the value of the field Exceptions ClassCastException: if the field is not of the correct type IllegalArgumentException: if this instance has no reflection field set on it

public boolean getBoolean(Object instance) throws ClassCastException, IllegalArgumentException

Get the boolean value of this field on the given object instance.

Parameters

instance:Object: the object instance (must not be null, must be of the correct type)

Returns:boolean

the value of the field

Exceptions

ClassCastException:: if the field is not of the correct type
IllegalArgumentException:: if this instance has no reflection field set on it

getByte back to summary

getByte	back to summary
public byte getByte(Object instance) throws ClassCastException, IllegalArgumentException Get the byte value of this field on the given object instance. Parameters instance:Object the object instance (must not be `null`, must be of the correct type) Returns:byte the value of the field Exceptions ClassCastException: if the field is not of the correct type IllegalArgumentException: if this instance has no reflection field set on it

public byte getByte(Object instance) throws ClassCastException, IllegalArgumentException

Get the byte value of this field on the given object instance.

Parameters

instance:Object: the object instance (must not be null, must be of the correct type)

Returns:byte

the value of the field

Exceptions

ClassCastException:: if the field is not of the correct type
IllegalArgumentException:: if this instance has no reflection field set on it

getChar back to summary

getChar	back to summary
public char getChar(Object instance) throws ClassCastException, IllegalArgumentException Get the char value of this field on the given object instance. Parameters instance:Object the object instance (must not be `null`, must be of the correct type) Returns:char the value of the field Exceptions ClassCastException: if the field is not of the correct type IllegalArgumentException: if this instance has no reflection field set on it

public char getChar(Object instance) throws ClassCastException, IllegalArgumentException

Get the char value of this field on the given object instance.

Parameters

instance:Object: the object instance (must not be null, must be of the correct type)

Returns:char

the value of the field

Exceptions

ClassCastException:: if the field is not of the correct type
IllegalArgumentException:: if this instance has no reflection field set on it

getDouble back to summary

getDouble	back to summary
public double getDouble(Object instance) throws ClassCastException, IllegalArgumentException Get the double value of this field on the given object instance. Parameters instance:Object the object instance (must not be `null`, must be of the correct type) Returns:double the value of the field Exceptions ClassCastException: if the field is not of the correct type IllegalArgumentException: if this instance has no reflection field set on it

public double getDouble(Object instance) throws ClassCastException, IllegalArgumentException

Get the double value of this field on the given object instance.

Parameters

instance:Object: the object instance (must not be null, must be of the correct type)

Returns:double

the value of the field

Exceptions

ClassCastException:: if the field is not of the correct type
IllegalArgumentException:: if this instance has no reflection field set on it

getField back to summary

getField	back to summary
public Field getField() Deprecated As of Java 9, accessible fields are generally disallowed; use the `#setXXX(Object,value)` methods instead. Get the reflection `Field` for this serializable field. The resultant field will be accessible. Returns:Field the reflection field Annotations @Deprecated

public Field getField()

Deprecated

As of Java 9, accessible fields are generally disallowed; use the #setXXX(Object,value) methods instead.

Get the reflection Field for this serializable field. The resultant field will be accessible.

Returns:Field

the reflection field

Annotations

@Deprecated

getFloat back to summary

getFloat	back to summary
public float getFloat(Object instance) throws ClassCastException, IllegalArgumentException Get the float value of this field on the given object instance. Parameters instance:Object the object instance (must not be `null`, must be of the correct type) Returns:float the value of the field Exceptions ClassCastException: if the field is not of the correct type IllegalArgumentException: if this instance has no reflection field set on it

public float getFloat(Object instance) throws ClassCastException, IllegalArgumentException

Get the float value of this field on the given object instance.

Parameters

instance:Object: the object instance (must not be null, must be of the correct type)

Returns:float

the value of the field

Exceptions

ClassCastException:: if the field is not of the correct type
IllegalArgumentException:: if this instance has no reflection field set on it

getInt back to summary

getInt	back to summary
public int getInt(Object instance) throws ClassCastException, IllegalArgumentException Get the integer value of this field on the given object instance. Parameters instance:Object the object instance (must not be `null`, must be of the correct type) Returns:int the value of the field Exceptions ClassCastException: if the field is not of the correct type IllegalArgumentException: if this instance has no reflection field set on it

public int getInt(Object instance) throws ClassCastException, IllegalArgumentException

Get the integer value of this field on the given object instance.

Parameters

instance:Object: the object instance (must not be null, must be of the correct type)

Returns:int

the value of the field

Exceptions

ClassCastException:: if the field is not of the correct type
IllegalArgumentException:: if this instance has no reflection field set on it

getKind	back to summary
public Kind getKind() Get the kind of field. Returns:Kind the kind

getKind

back to summary

public Kind getKind()

Get the kind of field.

Returns:Kind: the kind

getLong back to summary

getLong	back to summary
public long getLong(Object instance) throws ClassCastException, IllegalArgumentException Get the long value of this field on the given object instance. Parameters instance:Object the object instance (must not be `null`, must be of the correct type) Returns:long the value of the field Exceptions ClassCastException: if the field is not of the correct type IllegalArgumentException: if this instance has no reflection field set on it

public long getLong(Object instance) throws ClassCastException, IllegalArgumentException

Get the long value of this field on the given object instance.

Parameters

instance:Object: the object instance (must not be null, must be of the correct type)

Returns:long

the value of the field

Exceptions

ClassCastException:: if the field is not of the correct type
IllegalArgumentException:: if this instance has no reflection field set on it

getName	back to summary
public String getName() Get the name of the field. Returns:String the name

getName

back to summary

public String getName()

Get the name of the field.

Returns:String: the name

getObject back to summary

getObject	back to summary
public Object getObject(Object instance) throws ClassCastException, IllegalArgumentException Get the object value of this field on the given object instance. Parameters instance:Object the object instance (must not be `null`, must be of the correct type) Returns:Object the value of the field Exceptions ClassCastException: if the field is not of the correct type IllegalArgumentException: if this instance has no reflection field set on it

public Object getObject(Object instance) throws ClassCastException, IllegalArgumentException

Get the object value of this field on the given object instance.

Parameters

instance:Object: the object instance (must not be null, must be of the correct type)

Returns:Object

the value of the field

Exceptions

ClassCastException:: if the field is not of the correct type
IllegalArgumentException:: if this instance has no reflection field set on it

getRecordComponentIndex	back to summary
public int getRecordComponentIndex() Getter for the record component index. Returns:int The record component index or -1

getRecordComponentIndex

back to summary

public int getRecordComponentIndex()

Getter for the record component index.

Returns:int: The record component index or -1

getRecordComponentValue	back to summary
public Object getRecordComponentValue(Object obj) Getter for the record component value. Parameters obj:Object The object to obtain the record component value Returns:Object The record component value for this obj

getRecordComponentValue

back to summary

public Object getRecordComponentValue(Object obj)

Getter for the record component value.

Parameters

obj:Object: The object to obtain the record component value

Returns:Object

The record component value for this obj

getShort back to summary

getShort	back to summary
public short getShort(Object instance) throws ClassCastException, IllegalArgumentException Get the short value of this field on the given object instance. Parameters instance:Object the object instance (must not be `null`, must be of the correct type) Returns:short the value of the field Exceptions ClassCastException: if the field is not of the correct type IllegalArgumentException: if this instance has no reflection field set on it

public short getShort(Object instance) throws ClassCastException, IllegalArgumentException

Get the short value of this field on the given object instance.

Parameters

instance:Object: the object instance (must not be null, must be of the correct type)

Returns:short

the value of the field

Exceptions

ClassCastException:: if the field is not of the correct type
IllegalArgumentException:: if this instance has no reflection field set on it

getType	back to summary
public Class<?> getType() throws ClassNotFoundException Get the field type. Returns:Class<?> the field type

getType

back to summary

public Class<?> getType() throws ClassNotFoundException

Get the field type.

Returns:Class<?>: the field type

isAccessible back to summary

isAccessible	back to summary
public boolean isAccessible() Determine if this object may be used to get or set an object field value. Returns:boolean `true` if this object may be used to get or set an object field value, `false` otherwise

public boolean isAccessible()

Determine if this object may be used to get or set an object field value.

Returns:boolean: true if this object may be used to get or set an object field value, false otherwise

isUnshared back to summary

isUnshared	back to summary
public boolean isUnshared() Determine whether this field is marked as "unshared". Returns:boolean `true` if the field is unshared

public boolean isUnshared()

Determine whether this field is marked as "unshared".

Returns:boolean: true if the field is unshared

readFrom	back to summary
public void readFrom(Object instance, ObjectInput input) throws IOException, ClassNotFoundException Read the field value from the stream. Parameters instance:Object the instance input:ObjectInput the source stream Exceptions IOException: if an I/O error occurs ClassNotFoundException: if a class could not be loaded

readFrom

back to summary

public void readFrom(Object instance, ObjectInput input) throws IOException, ClassNotFoundException

Read the field value from the stream.

Parameters

instance:Object: the instance
input:ObjectInput: the source stream

Exceptions

IOException:: if an I/O error occurs
ClassNotFoundException:: if a class could not be loaded

setBoolean back to summary

setBoolean	back to summary
public void setBoolean(Object instance, boolean value) throws ClassCastException, IllegalArgumentException Set the boolean value of this field on the given object instance. Parameters instance:Object the object instance (must not be `null`, must be of the correct type) value:boolean the value to set Exceptions ClassCastException: if `instance` or the field is not of the correct type IllegalArgumentException: if this instance has no reflection field set on it

public void setBoolean(Object instance, boolean value) throws ClassCastException, IllegalArgumentException

Set the boolean value of this field on the given object instance.

Parameters

instance:Object: the object instance (must not be null, must be of the correct type)
value:boolean: the value to set

Exceptions

ClassCastException:: if instance or the field is not of the correct type
IllegalArgumentException:: if this instance has no reflection field set on it

setByte back to summary

setByte	back to summary
public void setByte(Object instance, byte value) throws ClassCastException, IllegalArgumentException Set the byte value of this field on the given object instance. Parameters instance:Object the object instance (must not be `null`, must be of the correct type) value:byte the value to set Exceptions ClassCastException: if `instance` is not of the correct type IllegalArgumentException: if this instance has no reflection field set on it

public void setByte(Object instance, byte value) throws ClassCastException, IllegalArgumentException

Set the byte value of this field on the given object instance.

Parameters

instance:Object: the object instance (must not be null, must be of the correct type)
value:byte: the value to set

Exceptions

ClassCastException:: if instance is not of the correct type
IllegalArgumentException:: if this instance has no reflection field set on it

setChar back to summary

setChar	back to summary
public void setChar(Object instance, char value) throws ClassCastException, IllegalArgumentException Set the char value of this field on the given object instance. Parameters instance:Object the object instance (must not be `null`, must be of the correct type) value:char the value to set Exceptions ClassCastException: if `instance` or the field is not of the correct type IllegalArgumentException: if this instance has no reflection field set on it

public void setChar(Object instance, char value) throws ClassCastException, IllegalArgumentException

Set the char value of this field on the given object instance.

Parameters

instance:Object: the object instance (must not be null, must be of the correct type)
value:char: the value to set

Exceptions

ClassCastException:: if instance or the field is not of the correct type
IllegalArgumentException:: if this instance has no reflection field set on it

setDouble back to summary

setDouble	back to summary
public void setDouble(Object instance, double value) throws ClassCastException, IllegalArgumentException Set the double value of this field on the given object instance. Parameters instance:Object the object instance (must not be `null`, must be of the correct type) value:double the value to set Exceptions ClassCastException: if `instance` or the field is not of the correct type IllegalArgumentException: if this instance has no reflection field set on it

public void setDouble(Object instance, double value) throws ClassCastException, IllegalArgumentException

Set the double value of this field on the given object instance.

Parameters

instance:Object: the object instance (must not be null, must be of the correct type)
value:double: the value to set

Exceptions

ClassCastException:: if instance or the field is not of the correct type
IllegalArgumentException:: if this instance has no reflection field set on it

setFloat back to summary

setFloat	back to summary
public void setFloat(Object instance, float value) throws ClassCastException, IllegalArgumentException Set the float value of this field on the given object instance. Parameters instance:Object the object instance (must not be `null`, must be of the correct type) value:float the value to set Exceptions ClassCastException: if `instance` or the field is not of the correct type IllegalArgumentException: if this instance has no reflection field set on it

public void setFloat(Object instance, float value) throws ClassCastException, IllegalArgumentException

Set the float value of this field on the given object instance.

Parameters

instance:Object: the object instance (must not be null, must be of the correct type)
value:float: the value to set

Exceptions

ClassCastException:: if instance or the field is not of the correct type
IllegalArgumentException:: if this instance has no reflection field set on it

setInt back to summary

setInt	back to summary
public void setInt(Object instance, int value) throws ClassCastException, IllegalArgumentException Set the integer value of this field on the given object instance. Parameters instance:Object the object instance (must not be `null`, must be of the correct type) value:int the value to set Exceptions ClassCastException: if `instance` or the field is not of the correct type IllegalArgumentException: if this instance has no reflection field set on it

public void setInt(Object instance, int value) throws ClassCastException, IllegalArgumentException

Set the integer value of this field on the given object instance.

Parameters

instance:Object: the object instance (must not be null, must be of the correct type)
value:int: the value to set

Exceptions

ClassCastException:: if instance or the field is not of the correct type
IllegalArgumentException:: if this instance has no reflection field set on it

setLong back to summary

setLong	back to summary
public void setLong(Object instance, long value) throws ClassCastException, IllegalArgumentException Set the long value of this field on the given object instance. Parameters instance:Object the object instance (must not be `null`, must be of the correct type) value:long the value to set Exceptions ClassCastException: if `instance` or the field is not of the correct type IllegalArgumentException: if this instance has no reflection field set on it

public void setLong(Object instance, long value) throws ClassCastException, IllegalArgumentException

Set the long value of this field on the given object instance.

Parameters

instance:Object: the object instance (must not be null, must be of the correct type)
value:long: the value to set

Exceptions

ClassCastException:: if instance or the field is not of the correct type
IllegalArgumentException:: if this instance has no reflection field set on it

setObject back to summary

setObject	back to summary
public void setObject(Object instance, Object value) throws ClassCastException, IllegalArgumentException Set the object value of this field on the given object instance. Parameters instance:Object the object instance (must not be `null`, must be of the correct type) value:Object the value to set Exceptions ClassCastException: if `instance` or the field is not of the correct type IllegalArgumentException: if this instance has no reflection field set on it

public void setObject(Object instance, Object value) throws ClassCastException, IllegalArgumentException

Set the object value of this field on the given object instance.

Parameters

instance:Object: the object instance (must not be null, must be of the correct type)
value:Object: the value to set

Exceptions

ClassCastException:: if instance or the field is not of the correct type
IllegalArgumentException:: if this instance has no reflection field set on it

setShort back to summary

setShort	back to summary
public void setShort(Object instance, short value) throws ClassCastException, IllegalArgumentException Set the short value of this field on the given object instance. Parameters instance:Object the object instance (must not be `null`, must be of the correct type) value:short the value to set Exceptions ClassCastException: if `instance` or the field is not of the correct type IllegalArgumentException: if this instance has no reflection field set on it

public void setShort(Object instance, short value) throws ClassCastException, IllegalArgumentException

Set the short value of this field on the given object instance.

Parameters

instance:Object: the object instance (must not be null, must be of the correct type)
value:short: the value to set

Exceptions

ClassCastException:: if instance or the field is not of the correct type
IllegalArgumentException:: if this instance has no reflection field set on it

writeTo	back to summary
public void writeTo(Object instance, ObjectOutput output) throws IOException

public final Class SerializableField

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Class SerializableField.RecordComponent

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Modifier and Type	Field and Description
private final int	index
private final String	name
private final Class<?>	type

Modifier and Type	Method and Description
public int	getIndex()
public String	getName()
public Class<?>	getType()