|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.sun.tools.xjc.model.CPropertyInfo
public abstract class CPropertyInfo
Model of a property to be generated.
| Field Summary | |
|---|---|
JType |
baseType
If the base type of the property is overriden, this field is set to non-null. |
CDefaultValue |
defaultValue
If non-null, keeps the default value in Java representation. |
boolean |
inlineBinaryData
Property with @XmlInlineBinaryData. |
String |
javadoc
Javadoc for this property. |
Locator |
locator
|
FieldRenderer |
realization
Specifies how the field is generated by the backend. |
| Constructor Summary | |
|---|---|
protected |
CPropertyInfo(String name,
boolean collection,
XSComponent source,
CCustomizations customizations,
Locator locator)
|
| Method Summary | ||
|---|---|---|
abstract
|
accept(CPropertyVisitor<V> visitor)
|
|
QName |
collectElementNames(Map<QName,CPropertyInfo> table)
Puts the element names that this property possesses to the map, so that we can find two properties that own the same element name, which is an error. |
|
String |
displayName()
|
|
abstract CAdapter |
getAdapter()
|
|
CCustomizations |
getCustomizations()
Gets the list of customizations attached to this model component. |
|
Locator |
getLocator()
Gets the source location in the schema from which this model component is created. |
|
String |
getName()
Deprecated. marked as deprecated so that we can spot the use of this method. |
|
String |
getName(boolean isPublic)
Gets the name of the property. |
|
XSComponent |
getSchemaComponent()
If this model object is built from XML Schema, this property returns a schema component from which the model is built. |
|
boolean |
hasAnnotation(Class<? extends Annotation> annotationType)
|
|
boolean |
inlineBinaryData()
|
|
boolean |
isCollection()
|
|
boolean |
isOptionalPrimitive()
Returns true if this property needs to represent null just for the purpose of representing an absence of the property. |
|
boolean |
isUnboxable()
Returns true if this property is "unboxable". |
|
protected static boolean |
needsExplicitTypeName(TypeUse type,
QName typeName)
Checks if the given TypeUse would need an explicit XmlSchemaType
annotation with the given type name. |
|
CTypeInfo |
parent()
|
|
|
readAnnotation(Class<A> annotationType)
|
|
abstract Collection<? extends CTypeInfo> |
ref()
|
|
void |
setName(boolean isPublic,
String newName)
Overrides the name of the property. |
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface com.sun.xml.bind.v2.model.core.PropertyInfo |
|---|
getExpectedMimeType, getSchemaType, id, kind |
| Field Detail |
|---|
public final Locator locator
public JType baseType
public String javadoc
public boolean inlineBinaryData
@XmlInlineBinaryData.
public FieldRenderer realization
public CDefaultValue defaultValue
isCollection is true, this field is always null,
for we don't handle default values for a list.
| Constructor Detail |
|---|
protected CPropertyInfo(String name,
boolean collection,
XSComponent source,
CCustomizations customizations,
Locator locator)
| Method Detail |
|---|
public CTypeInfo parent()
parent in interface PropertyInfo<NType,NClass>public Locator getLocator()
CCustomizable
getLocator in interface CCustomizablepublic final XSComponent getSchemaComponent()
getSchemaComponent in interface CCustomizablepublic abstract CAdapter getAdapter()
getAdapter in interface PropertyInfo<NType,NClass>public String getName()
This method is implemented to follow the contract of
PropertyInfo.getName(), and therefore it always
returns the name of the annotated field.
This name is normally not useful for the rest of XJC, which usually wants to access the "public name" of the property. A "public name" of the property is a name like "FooBar" which is used as a seed for generating the accessor methods. This is the name controlled by the schema customization via users.
If the caller is calling this method statically, it's usually
the sign of a mistake. Use getName(boolean) method instead,
which forces you to think about which name you want to get.
getName in interface PropertyInfo<NType,NClass>getName(boolean)public String getName(boolean isPublic)
isPublic - if true, this method returns a name like "FooBar", which
should be used as a seed for generating user-visible names
(such as accessors like "getFooBar".)
if false, this method returns the "name of the property" as defined in the j2s side of the spec. This name is usually something like "fooBar", which often corresponds to the XML element/attribute name of this property (for taking advantage of annotation defaulting as much as possible)
public void setName(boolean isPublic,
String newName)
Plugin#postProcessModel(Model, ErrorHandler).
But the caller should do so with the understanding that this is inherently
dangerous method.
public String displayName()
displayName in interface PropertyInfo<NType,NClass>public boolean isCollection()
isCollection in interface PropertyInfo<NType,NClass>public abstract Collection<? extends CTypeInfo> ref()
ref in interface PropertyInfo<NType,NClass>public boolean isUnboxable()
In general, a property often has to be capable of representing null to indicate the absence of the value. This requires properties to be generated as @XmlElement Float f, not as @XmlElement float f;. But this is slow.
Fortunately, there are cases where we know that the property can never legally be absent. When this condition holds we can generate the optimized "unboxed form".
The exact such conditions depend on the kind of properties, so refer to the implementation code for the details.
This method returns true when the property can be generated as "unboxed form", false otherwise.
When this property is a collection, this method returns true if items in the collection is unboxable. Obviously, the collection itself is always a reference type.
public boolean isOptionalPrimitive()
public CCustomizations getCustomizations()
CCustomizable
getCustomizations in interface CCustomizablePlugin.getCustomizationURIs()public boolean inlineBinaryData()
inlineBinaryData in interface PropertyInfo<NType,NClass>public abstract <V> V accept(CPropertyVisitor<V> visitor)
protected static boolean needsExplicitTypeName(TypeUse type,
QName typeName)
TypeUse would need an explicit XmlSchemaType
annotation with the given type name.
public QName collectElementNames(Map<QName,CPropertyInfo> table)
public final <A extends Annotation> A readAnnotation(Class<A> annotationType)
readAnnotation in interface AnnotationSourcepublic final boolean hasAnnotation(Class<? extends Annotation> annotationType)
hasAnnotation in interface AnnotationSource
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||