EclipseLink JPA 4.0.2 · org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataMethod

Field Summary

Modifier and Type	Field and Description
protected MetadataClass	m_metadataClass Class that the method is defined in.
protected MetadataMethod	m_next Used to store multiple methods with the same name in a class.
protected List<String>	m_parameters List of class names of method parameters.
protected String	m_returnType Class name of method return type.
protected MetadataMethod	m_setMethod Corresponding set method, if the method is an accessor get method.

Inherited from org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAnnotatedElement:: DEFAULT_RAW_CLASS m_primitiveType

Constructor Summary

Access	Constructor and Description
public	MetadataMethod(MetadataFactory factory, MetadataClass metadataClass) Create the method from the class metadata.

Method Summary

Modifier and Type	Method and Description
public void	addParameter(String parameter) INTERNAL:
public MetadataClass	getMetadataClass() INTERNAL:
public MetadataMethod	getNext() INTERNAL:
public List<String>	getParameters() INTERNAL:
public String	getReturnType() INTERNAL:
public MetadataMethod	getSetMethod() INTERNAL: Method to convert a getMethod into a setMethod.
public MetadataMethod	getSetMethod(MetadataClass cls) INTERNAL: Method to convert a getMethod into a setMethod.
public String	getSetMethodName() INTERNAL:
public boolean	hasAttributeName() INTERNAL:
public boolean	hasParameters() INTERNAL:
public boolean	hasSetMethod() INTERNAL:
public boolean	isALifeCycleCallbackMethod() INTERNAL: Return true if it has a valid name (starts with get or is) and has a property name (getXyz or isXyz) and does not have parameters and has an associated set method.
protected boolean	isValidPersistenceMethod() INTERNAL: Return true if it has a valid name (starts with 'get' or 'is') and has a property name (get'Xyz' or is'Xyz') and does not have parameters and has an associated set method.
public boolean	isValidPersistenceMethod(boolean mustBeExplicit, ClassAccessor classAccessor) INTERNAL: Return true is this method is a valid persistence method.
public boolean	isValidPersistenceMethod(ClassAccessor classAccessor, boolean userDecorated) INTERNAL: Return true is this method is a valid persistence method.
public boolean	isValidPersistenceMethodName() INTERNAL:
public void	setMetadataClass(MetadataClass metadataClass) INTERNAL:
public void	setNext(MetadataMethod next) INTERNAL:
public void	setParameters(List<String> parameters) INTERNAL:
public void	setReturnType(String returnType) INTERNAL:
public void	setSetMethod(MetadataMethod method) INTERNAL: Method to convert a getMethod into a setMethod.

Inherited from org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAnnotatedElement:: addAnnotation addGenericType addMetaAnnotation areAnnotationsCompatibleWithTransient equals getAnnotation getAnnotation getAnnotation getAnnotation getAnnotations getAttributeName getDeclaredAnnotationsCount getGenericType getMapKeyClass getModifiers getName getPrimitiveType getRawClass getRawClassWithGenerics getReferenceClassFromGeneric getType hasDeclaredAnnotations hashCode isAnnotationNotPresent isAnnotationNotPresent isAnnotationPresent isAnnotationPresent isAnnotationPresent isArray isBasic isBasicCollection isBasicMap isDerivedId isDerivedIdClass isElementCollection isEmbedded isEmbeddedId isGenericCollectionType isGenericType isId isManyToMany isManyToOne isOneToMany isOneToOne isStructure isSupportedCollectionClass isSupportedMapClass isSupportedToManyCollectionClass isTransformation isValidPersistenceElement isValidPersistenceElement isVariableOneToOne isVersion setAnnotations setAttributeName setGenericType setModifiers setName setPrimitiveType setType toString

Field Detail

m_metadataClass	back to summary
protected MetadataClass m_metadataClass Class that the method is defined in.

m_next	back to summary
protected MetadataMethod m_next Used to store multiple methods with the same name in a class.

m_parameters	back to summary
protected List<String> m_parameters List of class names of method parameters.

m_returnType	back to summary
protected String m_returnType Class name of method return type.

m_setMethod	back to summary
protected MetadataMethod m_setMethod Corresponding set method, if the method is an accessor get method.

Constructor Detail

MetadataMethod	back to summary
public MetadataMethod(MetadataFactory factory, MetadataClass metadataClass) Create the method from the class metadata.

Method Detail

addParameter	back to summary
public void addParameter(String parameter) INTERNAL:

getMetadataClass	back to summary
public MetadataClass getMetadataClass() INTERNAL:

getNext	back to summary
public MetadataMethod getNext() INTERNAL:

getParameters	back to summary
public List<String> getParameters() INTERNAL:

getReturnType	back to summary
public String getReturnType() INTERNAL:

getSetMethod	back to summary
public MetadataMethod getSetMethod() INTERNAL: Method to convert a getMethod into a setMethod. This method could return null if the corresponding set method is not found.

getSetMethod	back to summary
public MetadataMethod getSetMethod(MetadataClass cls) INTERNAL: Method to convert a getMethod into a setMethod. This method could return null if the corresponding set method is not found.

getSetMethodName	back to summary
public String getSetMethodName() INTERNAL:

hasAttributeName	back to summary
public boolean hasAttributeName() INTERNAL:

hasParameters	back to summary
public boolean hasParameters() INTERNAL:

hasSetMethod	back to summary
public boolean hasSetMethod() INTERNAL:

isALifeCycleCallbackMethod	back to summary
public boolean isALifeCycleCallbackMethod() INTERNAL: Return true if it has a valid name (starts with get or is) and has a property name (getXyz or isXyz) and does not have parameters and has an associated set method.

isValidPersistenceMethod	back to summary
protected boolean isValidPersistenceMethod() INTERNAL: Return true if it has a valid name (starts with 'get' or 'is') and has a property name (get'Xyz' or is'Xyz') and does not have parameters and has an associated set method.

isValidPersistenceMethod

back to summary

public boolean isValidPersistenceMethod(boolean mustBeExplicit, ClassAccessor classAccessor)

INTERNAL: Return true is this method is a valid persistence method. This method will validate against any declared annotations on the method. If the mustBeExplicit flag is true, then we are processing the inverse of an explicit access setting and the property must have an Access(PROPERTY) setting to be processed. Otherwise, it is ignored.

isValidPersistenceMethod	back to summary
public boolean isValidPersistenceMethod(ClassAccessor classAccessor, boolean userDecorated) INTERNAL: Return true is this method is a valid persistence method. User decorated is used to indicate that the method either had persistence annotations defined on it or that it was specified in XML.

isValidPersistenceMethodName	back to summary
public boolean isValidPersistenceMethodName() INTERNAL:

setMetadataClass	back to summary
public void setMetadataClass(MetadataClass metadataClass) INTERNAL:

setNext	back to summary
public void setNext(MetadataMethod next) INTERNAL:

setParameters	back to summary
public void setParameters(List<String> parameters) INTERNAL:

setReturnType	back to summary
public void setReturnType(String returnType) INTERNAL: