net.lecousin.framework.io.serialization

Class SerializationClass.Attribute

java.lang.Object

net.lecousin.framework.io.serialization.SerializationClass.Attribute

Direct Known Subclasses:

CustomAttributeSerializer.CustomAttribute

Enclosing class:

SerializationClass

public static class SerializationClass.Attribute
extends Object

Represent an attribute of the class.

Field Summary

Fields

Modifier and Type	Field and Description
protected Field	field
protected Method	getter
protected boolean	ignore
protected String	name
protected String	originalName
protected TypeDefinition	originalType
protected SerializationClass	parent
protected Method	setter
protected TypeDefinition	type

Constructor Summary

Constructors

Constructor and Description
Attribute(SerializationClass.Attribute copy) Constructor.
Attribute(SerializationClass parent, Field f) Constructor.
Attribute(SerializationClass parent, String name, TypeDefinition type) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	canGet() Return true if a getter exists or the field is public.
boolean	canSet() Return true if a setter exists or the field is public.
<T extends Annotation> T	getAnnotation(boolean onGet, Class<T> annotationType) Retrieve a specific annotation.
List<Annotation>	getAnnotations(boolean onGet) Retrieve all annotations.
Class<?>	getDeclaringClass() Return the declaring class of the field or the getter or the setter.
Field	getField()
Method	getGetter()
String	getName()
String	getOriginalName()
TypeDefinition	getOriginalType()
SerializationClass	getParent()
Method	getSetter()
TypeDefinition	getType()
Object	getValue(Object instance) Return the value of this attribute for the given instance.
boolean	hasCustomInstantiation() Return true if this attribute has a custom instantiation and no type information should not be serialized.
boolean	ignore() Return true if this attribute must be ignored during (de)serialization.
void	ignore(boolean ignore) Set the ignore flag.
Object	instantiate(SerializationContext.AttributeContext context) Instantiate a new object of the type of this attribute.
void	renameTo(String newName) Rename this attribute.
void	setType(TypeDefinition type)
void	setValue(Object instance, Object value) Set the value of this attribute for the given instance.

Methods inherited from class java.lang.Object

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

Field Detail

parent

protected SerializationClass parent

name

protected String name

originalName

protected String originalName

field

protected Field field

getter

protected Method getter

setter

protected Method setter

type

protected TypeDefinition type

originalType

protected TypeDefinition originalType

ignore

protected boolean ignore

Constructor Detail

Attribute

public Attribute(SerializationClass parent,
                 String name,
                 TypeDefinition type)

Constructor.

Attribute

public Attribute(SerializationClass parent,
                 Field f)

Constructor.

Attribute

public Attribute(SerializationClass.Attribute copy)

Constructor.

Method Detail

getParent

public SerializationClass getParent()

getName

public String getName()

getOriginalName

public String getOriginalName()

getField

public Field getField()

getGetter

public Method getGetter()

getSetter

public Method getSetter()

getType

public TypeDefinition getType()

getOriginalType

public TypeDefinition getOriginalType()

ignore

public boolean ignore()

Return true if this attribute must be ignored during (de)serialization.

ignore

public void ignore(boolean ignore)

Set the ignore flag.

renameTo

public void renameTo(String newName)

Rename this attribute.

setType

public void setType(TypeDefinition type)

getDeclaringClass

public Class<?> getDeclaringClass()

Return the declaring class of the field or the getter or the setter.

canGet

public boolean canGet()

Return true if a getter exists or the field is public.

canSet

public boolean canSet()

Return true if a setter exists or the field is public.

getValue

public Object getValue(Object instance)
                throws SerializationException

Return the value of this attribute for the given instance.

Throws:

SerializationException

setValue

public void setValue(Object instance,
                     Object value)
              throws SerializationException

Set the value of this attribute for the given instance.

Throws:

SerializationException

instantiate

public Object instantiate(SerializationContext.AttributeContext context)
                   throws SerializationException

Instantiate a new object of the type of this attribute.

Throws:

SerializationException

hasCustomInstantiation

public boolean hasCustomInstantiation()

Return true if this attribute has a custom instantiation and no type information should not be serialized.

getAnnotation

public <T extends Annotation> T getAnnotation(boolean onGet,
                                              Class<T> annotationType)

Retrieve a specific annotation.

getAnnotations

public List<Annotation> getAnnotations(boolean onGet)

Retrieve all annotations.