org.jadira.reflection.access.model

Class ClassModel<C>

java.lang.Object

org.jadira.reflection.access.model.ClassModel<C>

public class ClassModel<C>
extends Object

Provides a base model resulting from introspection of a class

Method Summary

Modifier and Type	Method and Description
static <C> ClassModel<C>	get(ClassAccess<C> classAccess) Returns a class model for the given ClassAccess instance.
ClassAccess<C>	getClassAccess() Access the ClassAccess associated with the ClassModel
CloneImplementor	getCloneImplementor() If there is a method or constructor configured as a @Cloner instance, the CloneImplementor that can invoke this method will be returned
Class<?>	getModelClass() Access the Class associated with the ClassModel
FieldModel<C>[]	getModelFields() Return an array of FieldModel for the class - one entry per Field
ClassModel<? super C>	getSuperClassModel() Access the model for the super class
boolean	isDetectedAsImmutable() Indicates whether the class has been determined to be immutable
boolean	isFlat() Indicates whether the class should be treated as Flat.
boolean	isNonCloneable() Indicates whether the class should be treated as Non-Cloneable.

Methods inherited from class java.lang.Object

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

Method Detail

get

public static final <C> ClassModel<C> get(ClassAccess<C> classAccess)

Returns a class model for the given ClassAccess instance. If a ClassModel already exists, it will be reused.

Type Parameters:

C - The type of class

Parameters:

classAccess - The ClassAccess

Returns:

The Field Model

getModelClass

public Class<?> getModelClass()

Access the Class associated with the ClassModel

Returns:

The associated Class

getClassAccess

public ClassAccess<C> getClassAccess()

Access the ClassAccess associated with the ClassModel

Returns:

The associated ClassAccess.

getSuperClassModel

public ClassModel<? super C> getSuperClassModel()

Access the model for the super class

Returns:

The associated ClassModel

isDetectedAsImmutable

public boolean isDetectedAsImmutable()

Indicates whether the class has been determined to be immutable

Returns:

True if detected as immutable

isNonCloneable

public boolean isNonCloneable()

Indicates whether the class should be treated as Non-Cloneable. Such a class should not be cloned - i.e. the same instance should be returned (as with immutable objects)

Returns:

True if detected as non-cloneable

isFlat

public boolean isFlat()

Indicates whether the class should be treated as Flat. When a Flat class is encountered, references are no longer tracked as it is assumed that any reference only appears once. This allows a significant increase in performance

Returns:

True if detected as flat

getCloneImplementor

public CloneImplementor getCloneImplementor()

If there is a method or constructor configured as a @Cloner instance, the CloneImplementor that can invoke this method will be returned

Returns:

The configured CloneImplementor or null

getModelFields

public FieldModel<C>[] getModelFields()

Return an array of FieldModel for the class - one entry per Field

Returns:

The FieldModels for the class