Method | Description | |
---|---|---|
ElementArrayLabel ( Contact contact, |
Constructor for the
|
|
GetConverter ( Context context ) : Converter | ||
GetConverter ( Context context, String name ) : Converter |
This will create a
|
|
GetEmpty ( Context context ) : Object |
This is used to provide a configured empty value used when the annotated value is null. This ensures that XML can be created with required details regardless of whether values are null or not. It also provides a means for sensible default values.
|
|
GetEntry ( Context context ) : String |
This is used to either provide the entry value provided within the annotation or compute a entry value. If the entry string is not provided the the entry value is calculated as the type of primitive the object is as a simplified class name.
|
|
GetName ( Context context ) : String |
This is used to acquire the name of the element or attribute that is used by the class schema. The name is determined by checking for an override within the annotation. If it contains a name then that is used, if however the annotation does not specify a name the the field or method name is used instead.
|
|
IsAttribute ( ) : bool | ||
IsCollection ( ) : bool |
This is used to determine if the label is a collection. If the label represents a collection then any original assignment to the field or method can be written to without the need to create a new collection. This allows obscure collections to be used and also allows initial entries to be maintained.
|
|
IsData ( ) : bool |
This is used to determine whether the annotation requires it and its children to be written as a CDATA block. This is done when a primitive or other such element requires a text value and that value needs to be encapsulated within a CDATA block.
|
|
IsInline ( ) : bool |
This method is used by the deserialization process to check to see if an annotation is inline or not. If an annotation represents an inline XML entity then the deserialization and serialization process ignores overrides and special attributes. By default element arrays are not inline.
|
|
IsRequired ( ) : bool |
This is used to determine whether the XML element is required. This ensures that if an XML element is missing from a document that deserialization can continue. Also, in the process of serialization, if a value is null it does not need to be written to the resulting XML document.
|
|
ToString ( ) : String |
This is used to describe the annotation and method or field that this label represents. This is used to provide error messages that can be used to debug issues that occur when processing a method. This will provide enough information such that the problem can be isolated correctly.
|
public ElementArrayLabel ( Contact contact, |
||
contact | Contact | /// this is the contact that this label represents /// |
label | /// the annotation that contains the schema details /// | |
return | SimpleFramework.Xml.Strategy |
public GetConverter ( Context context ) : Converter | ||
context | Context | /// this is the context object used for serialization /// |
return | Converter |
public GetConverter ( Context context, String name ) : Converter | ||
context | Context | /// this is the context object used for serialization /// |
name | String | /// this is the name of the entry XML element to use /// |
return | Converter |
public GetEmpty ( Context context ) : Object | ||
context | Context | /// this is the context object for the serialization /// |
return | Object |
public GetEntry ( Context context ) : String | ||
context | Context | /// this is the context used to style the entry /// |
return | String |
public GetName ( Context context ) : String | ||
context | Context | /// this is the context used to style the name /// |
return | String |