Class ContentListField
- All Implemented Interfaces:
FieldOutline
List
.
List getXXX();
Default value handling
Since unmarshaller just adds new values into the storage, we can't fill the storage by default values at the time of instanciation. (or oherwise values found in the document will be appended to default values, where it should overwrite them.)
Therefore, when the object is created, the storage will be empty. When the getXXX method is called, we'll check if the storage is modified in anyway. If it is modified, it must mean that the values are found in the document, so we just return it. Otherwise we will fill in default values and return it to the user.
When a list has default values, its dirty flag is set to true. Marshaller will check this and treat it appropriately.
- Author:
- Kohsuke Kawaguchi ([email protected])
-
Field Summary
Modifier and TypeFieldDescriptionprotected final JCodeModel
protected final JType
The publicly visible type of this field.protected JFieldVar
The field that stores the list.protected final JType
The type of this field, which can hold all the possible types.protected final JClass
protected final ClassOutlineImpl
protected final JPrimitiveType
If this collection property is a collection of a primitive type, this variable refers to that primitive type.protected final CPropertyInfo
-
Constructor Summary
ModifierConstructorDescriptionprotected
ContentListField
(ClassOutlineImpl context, CPropertyInfo prop, JClass coreList) -
Method Summary
Modifier and TypeMethodDescriptionprotected void
annotate
(JAnnotatable field) Annotate the field according to the recipes given asCPropertyInfo
.protected final JExpression
Cast fromexposedType
toimplType
if necessary.create
(JExpression targetObject) Creates a newFieldAccessor
of this field for the specified object.protected final void
fixNullRef
(JBlock block) Generates statement(s) so that the successiveAbstractListField.Accessor.ref(boolean)
with true will always return a non-null list.protected final void
generate()
void
Generates accessor methods.protected final JFieldVar
generateField
(JType type) Generates the field declaration.protected final JClass
Concrete class that implements the List interface.protected final Options
Gets theOptions
in the current compilation context.final CPropertyInfo
Gets the corresponding model object.Gets the type of the "raw value".protected JType
Compute the type of aCPropertyInfo
Returns contents to be added to javadoc.final ClassOutline
parent()
Gets the enclosingClassOutline
.
-
Field Details
-
field
The field that stores the list. -
primitiveType
If this collection property is a collection of a primitive type, this variable refers to that primitive type. Otherwise null. -
listT
-
outline
-
prop
-
codeModel
-
implType
The type of this field, which can hold all the possible types. -
exposedType
The publicly visible type of this field. If we are generating value classes implType==exposedType.
-
-
Constructor Details
-
ContentListField
- Parameters:
coreList
- A concrete class that implements the List interface. An instance of this class will be used to store data for this field.
-
-
Method Details
-
getCoreListType
Concrete class that implements the List interface. Used as the actual data storage. -
generateAccessors
public void generateAccessors()Generates accessor methods. -
create
Description copied from interface:FieldOutline
Creates a newFieldAccessor
of this field for the specified object.- Parameters:
targetObject
- Evaluates to an object, and the field on this object will be accessed.
-
getType
Compute the type of aCPropertyInfo
-
generate
protected final void generate() -
fixNullRef
Generates statement(s) so that the successiveAbstractListField.Accessor.ref(boolean)
with true will always return a non-null list. This is useful to avoid generating redundant internal getter. -
getRawType
Description copied from interface:FieldOutline
Gets the type of the "raw value".This type can represent the entire value of this field. For fields that can carry multiple values, this is an array.
This type allows the client of the outline to generate code to set/get values from a property.
-
parent
Description copied from interface:FieldOutline
Gets the enclosingClassOutline
.- Specified by:
parent
in interfaceFieldOutline
-
getPropertyInfo
Description copied from interface:FieldOutline
Gets the corresponding model object.- Specified by:
getPropertyInfo
in interfaceFieldOutline
-
annotate
Annotate the field according to the recipes given asCPropertyInfo
. -
getOptions
Gets theOptions
in the current compilation context. -
generateField
Generates the field declaration. -
castToImplType
Cast fromexposedType
toimplType
if necessary. -
listPossibleTypes
Returns contents to be added to javadoc.
-