com.sun.tools.xjc.addon.xew

Class Candidate

java.lang.Object

com.sun.tools.xjc.addon.xew.Candidate

public final class Candidate
extends Object

Describes the collection container class - a candidate for removal. This class class has only one field - collection of objects.

Method Summary

Modifier and Type	Method and Description
boolean	addObjectFactoryForClass(com.sun.codemodel.JDefinedClass clazz) For the given class locate and add Object Factory classes to the map.
boolean	canBeRemoved() Has given candidate green light to be removed?
String	getClassName() Container class name
com.sun.codemodel.JDefinedClass	getClazz() Container class
com.sun.codemodel.JFieldVar	getField() The only field in container class (collection property).
com.sun.codemodel.JClass	getFieldClass() The class of the only field in container class (collection interface or particular implementation).
String	getFieldName() The name of the only field in container class.
com.sun.tools.xjc.model.CPropertyInfo	getFieldPropertyInfo() The corresponding property info of the only field in container class.
String	getFieldTargetNamespace() The XSD namespace of the property associated with a field.
Collection<com.sun.codemodel.JDefinedClass>	getObjectFactoryClasses() Object Factory classes for value (implementation) classes, interface classes and extra packages.
Collection<ParametrisationInfo>	getParametrisationInfos() The list of parametrisation classes of the field (collection types).
Map<com.sun.codemodel.JMethod,ScopedMethodInfo>	getScopedFactoryMethods() Return information about scoped methods that have this candidate as a scope.
void	incrementSubstitutions() Increments number of substitutions for this candidate.
boolean	isValueObjectDisabled() Returns true if the setting <jaxb:globalBindings generateValueClass="false"> is active.
String	toString()
void	unmarkForRemoval() Signal that this candidate should not be removed from model on some reason.

Methods inherited from class java.lang.Object

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

Method Detail

getClazz

public com.sun.codemodel.JDefinedClass getClazz()

Container class

getClassName

public String getClassName()

Container class name

getField

public com.sun.codemodel.JFieldVar getField()

The only field in container class (collection property).

getFieldName

public String getFieldName()

The name of the only field in container class.

getFieldClass

public com.sun.codemodel.JClass getFieldClass()

The class of the only field in container class (collection interface or particular implementation).

getFieldPropertyInfo

public com.sun.tools.xjc.model.CPropertyInfo getFieldPropertyInfo()

The corresponding property info of the only field in container class.

getFieldTargetNamespace

public String getFieldTargetNamespace()

The XSD namespace of the property associated with a field.

getParametrisationInfos

public Collection<ParametrisationInfo> getParametrisationInfos()

The list of parametrisation classes of the field (collection types). In case of basic parametrisation like List<String> this collection is empty.

getScopedFactoryMethods

public Map<com.sun.codemodel.JMethod,ScopedMethodInfo> getScopedFactoryMethods()

Return information about scoped methods that have this candidate as a scope.

Returns:

object factory method name -to- element info map

getObjectFactoryClasses

public Collection<com.sun.codemodel.JDefinedClass> getObjectFactoryClasses()

Object Factory classes for value (implementation) classes, interface classes and extra packages. Cannot be empty.

addObjectFactoryForClass

public boolean addObjectFactoryForClass(com.sun.codemodel.JDefinedClass clazz)

For the given class locate and add Object Factory classes to the map.

Returns:

true if value class generation is enabled

isValueObjectDisabled

public boolean isValueObjectDisabled()

Returns true if the setting <jaxb:globalBindings generateValueClass="false"> is active.

canBeRemoved

public boolean canBeRemoved()

Has given candidate green light to be removed?

incrementSubstitutions

public void incrementSubstitutions()

Increments number of substitutions for this candidate.

unmarkForRemoval

public void unmarkForRemoval()

Signal that this candidate should not be removed from model on some reason.

toString

public String toString()

Overrides:

toString in class Object