Package org.simpleframework.xml.core
Class DetailScanner
java.lang.Object
org.simpleframework.xml.core.DetailScanner
- All Implemented Interfaces:
Detail
The
DetailScanner
is used to scan a class for methods
and fields as well as annotations. Scanning a type in this way
ensures that all its details can be extracted and cached in one
place. This greatly improves performance on platforms that do not
cache reflection well, like Android.-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate DefaultType
This represents the default access type declared or the type.private NamespaceList
This represents the namespace list declared on the type.private List
<FieldDetail> This contains a list of fields that are extracted for this.private Annotation[]
This represents all the annotations declared for the type.private List
<MethodDetail> This contains a list of methods that are extracted for this.private String
This represents the name of the type used for XML elements.private Namespace
This represents the namespace annotation declared on the type.private Order
This is the order annotation that is declared for the type.private DefaultType
This represents the access type override declared or the type.private boolean
This is used to determine if the default type is required.private Root
This is the root annotation that is declared for the type.private boolean
This is used to determine if strict XML parsing is done.private Class
This is the type that is represented by this instance. -
Constructor Summary
ConstructorsConstructorDescriptionDetailScanner
(Class type) Constructor for theDetailScanner
object.DetailScanner
(Class type, DefaultType override) Constructor for theDetailScanner
object. -
Method Summary
Modifier and TypeMethodDescriptionprivate void
access
(Annotation label) This is used to set the optionalDefault
annotation for the class.private void
This method is used to extract the annotations associated with the type.private void
This is used to scan the type for its declared fields.This returns theDefault
annotation access type that has been specified by this.This returns the annotations that have been declared for this type.This returns the constructors that have been declared for this type.This returns a list of the fields that belong to this type.This returns a list of the methods that belong to this type.getName()
This returns the name of the class processed by this scanner.This returns theNamespace
annotation that was declared on the type.This returns theNamespaceList
annotation that was declared on the type.getOrder()
This returns the order annotation used to determine the order of serialization of attributes and elements.This returns theDefaultType
override used for this detail.getRoot()
This returns theRoot
annotation for the class.getSuper()
This is used to acquire the super type for the class that is represented by this detail.getType()
This returns the type represented by this detail.private boolean
This method is used to determine if a root annotation value is an empty value.boolean
This is used to determine if the class is an inner class.boolean
This is used to determine whether this detail represents a primitive type.boolean
This is used to determine if the generated annotations are required or not.boolean
isStrict()
This method is used to determine whether strict mappings are required.private void
This is used to scan the type for its declared methods.private void
namespace
(Annotation label) This is use to scan forNamespace
annotations on the class.private void
order
(Annotation label) This is used to set the optionalOrder
annotation for the class.private void
root
(Annotation label) This is used to set the optionalRoot
annotation for the class.private void
This method is used to scan the type for all of its annotations as well as its methods and fields.private void
scope
(Annotation label) This is use to scan forNamespaceList
annotations on the class.toString()
This is used to return a string representation of the detail.
-
Field Details
-
methods
This contains a list of methods that are extracted for this. -
fields
This contains a list of fields that are extracted for this. -
declaration
This represents the namespace list declared on the type. -
namespace
This represents the namespace annotation declared on the type. -
labels
This represents all the annotations declared for the type. -
override
This represents the access type override declared or the type. -
access
This represents the default access type declared or the type. -
order
This is the order annotation that is declared for the type. -
root
This is the root annotation that is declared for the type. -
type
This is the type that is represented by this instance. -
name
This represents the name of the type used for XML elements. -
required
private boolean requiredThis is used to determine if the default type is required. -
strict
private boolean strictThis is used to determine if strict XML parsing is done.
-
-
Constructor Details
-
DetailScanner
Constructor for theDetailScanner
object. This is used to create a detail object from a type. All of the methods fields and annotations are extracted so that they can be used many times over without the need to process them again.- Parameters:
type
- this is the type to scan for various details
-
DetailScanner
Constructor for theDetailScanner
object. This is used to create a detail object from a type. All of the methods fields and annotations are extracted so that they can be used many times over without the need to process them again.- Parameters:
type
- this is the type to scan for various detailsoverride
- this is the override used for this detail
-
-
Method Details
-
isRequired
public boolean isRequired()This is used to determine if the generated annotations are required or not. By default generated parameters are required. Setting this to false means that null values are accepted by all defaulted fields or methods depending on the type.- Specified by:
isRequired
in interfaceDetail
- Returns:
- this is used to determine if defaults are required
-
isStrict
public boolean isStrict()This method is used to determine whether strict mappings are required. Strict mapping means that all labels in the class schema must match the XML elements and attributes in the source XML document. When strict mapping is disabled, then XML elements and attributes that do not exist in the schema class will be ignored without breaking the parser. -
isPrimitive
public boolean isPrimitive()This is used to determine whether this detail represents a primitive type. A primitive type is any type that does not extendObject
, examples are int, long and double.- Specified by:
isPrimitive
in interfaceDetail
- Returns:
- this returns true if no XML annotations were found
-
isInstantiable
public boolean isInstantiable()This is used to determine if the class is an inner class. If the class is a inner class and not static then this returns false. Only static inner classes can be instantiated using reflection as they do not require a "this" argument.- Specified by:
isInstantiable
in interfaceDetail
- Returns:
- this returns true if the class is a static inner
-
getRoot
This returns theRoot
annotation for the class. The root determines the type of deserialization that is to be performed and also contains the name of the root element. -
getName
This returns the name of the class processed by this scanner. The name is either the name as specified in the last foundRoot
annotation, or if a name was not specified within the discovered root then the Java Bean class name of the last class annotated with a root annotation. -
getType
This returns the type represented by this detail. The type is the class that has been scanned for annotations, methods and fields. All super types of this are represented in the detail. -
getOrder
This returns the order annotation used to determine the order of serialization of attributes and elements. The order is a class level annotation that can be used only once per class XML schema. If none exists then this will return null. of the class processed by this scanner. -
getOverride
This returns theDefaultType
override used for this detail. An override is used only when the class contains no annotations and does not have aTransform
of any type associated with it. It allows serialization of external objects without the need to annotate the types.- Specified by:
getOverride
in interfaceDetail
- Returns:
- this returns the access type override for this type
-
getAccess
This returns theDefault
annotation access type that has been specified by this. If no default annotation has been declared on the type then this will return null. -
getNamespace
This returns theNamespace
annotation that was declared on the type. If no annotation has been declared on the type this will return null as not belonging to any.- Specified by:
getNamespace
in interfaceDetail
- Returns:
- this returns the namespace this type belongs to, if any
-
getNamespaceList
This returns theNamespaceList
annotation that was declared on the type. A list of namespaces are used to simply declare the namespaces without specifically making the type belong to any of the declared namespaces.- Specified by:
getNamespaceList
in interfaceDetail
- Returns:
- this returns the namespace declarations, if any
-
getMethods
This returns a list of the methods that belong to this type. The methods here do not include any methods from the super types and simply provides a means of caching method data.- Specified by:
getMethods
in interfaceDetail
- Returns:
- returns the list of methods declared for the type
-
getFields
This returns a list of the fields that belong to this type. The fields here do not include any fields from the super types and simply provides a means of caching method data. -
getAnnotations
This returns the annotations that have been declared for this type. It is preferable to acquire the declared annotations from this method as they are cached. Older versions of some runtime environments, particularly Android, are slow at this.- Specified by:
getAnnotations
in interfaceDetail
- Returns:
- this returns the annotations associated with this
-
getConstructors
This returns the constructors that have been declared for this type. It is preferable to acquire the declared constructors from this method as they are cached. Older versions of some runtime environments, particularly Android, are slow at this.- Specified by:
getConstructors
in interfaceDetail
- Returns:
- this returns the constructors associated with this
-
getSuper
This is used to acquire the super type for the class that is represented by this detail. If the super type for the class isObject
then this will return null. -
scan
This method is used to scan the type for all of its annotations as well as its methods and fields. Everything that is scanned is cached within the instance to ensure that it can be reused when ever an object of this type is to be scanned.- Parameters:
type
- this is the type to scan for details
-
extract
This method is used to extract the annotations associated with the type. Annotations extracted include theRoot
annotation and theNamespace
annotation as well as other annotations that are used to describe the type.- Parameters:
type
- this is the type to extract the annotations from
-
methods
This is used to scan the type for its declared methods. Scanning of the methods in this way allows the detail to prepare a cache that can be used to acquire the methods and the associated annotations. This improves performance on some platforms.- Parameters:
type
- this is the type to scan for declared annotations
-
fields
This is used to scan the type for its declared fields. Scanning of the fields in this way allows the detail to prepare a cache that can be used to acquire the fields and the associated annotations. This improves performance on some platforms.- Parameters:
type
- this is the type to scan for declared annotations
-
root
This is used to set the optionalRoot
annotation for the class. The root can only be set once, so if a super type also has a root annotation define it must be ignored.- Parameters:
label
- this is the label used to define the root
-
isEmpty
This method is used to determine if a root annotation value is an empty value. Rather than determining if a string is empty be comparing it to an empty string this method allows for the value an empty string represents to be changed in future.- Parameters:
value
- this is the value to determine if it is empty- Returns:
- true if the string value specified is an empty value
-
order
This is used to set the optionalOrder
annotation for the class. The order can only be set once, so if a super type also has a order annotation define it must be ignored.- Parameters:
label
- this is the label used to define the order
-
access
This is used to set the optionalDefault
annotation for the class. The default can only be set once, so if a super type also has a default annotation define it must be ignored.- Parameters:
label
- this is the label used to define the defaults
-
namespace
This is use to scan forNamespace
annotations on the class. Once a namespace has been located then it is used to populate the internal namespace decorator. This can then be used to decorate any output node that requires it.- Parameters:
label
- the XML annotation to scan for the namespace
-
scope
This is use to scan forNamespaceList
annotations on the class. Once a namespace list has been located then it is used to populate the internal namespace decorator. This can then be used to decorate any output node that requires it.- Parameters:
label
- the XML annotation to scan for namespace lists
-
toString
This is used to return a string representation of the detail. The string returned from this is the same that is returned from thetoString
of the type represented.
-