de.smartics.properties.spi.core.metadata
Class MetaInfDocumentMetaDataProxy

java.lang.Object
  de.smartics.properties.spi.core.metadata.MetaInfDocumentMetaDataProxy

All Implemented Interfaces:

DocumentMetaDataProxy, Serializable

@ThreadSafe
public final class MetaInfDocumentMetaDataProxy
     
     

      
      extends 
      
      Object
     
     
     
     

      
      implements 
      
      DocumentMetaDataProxy
     
     

Allows to lazy load annotation information.

See Also:

Serialized Form

Constructor Summary

MetaInfDocumentMetaDataProxy(PropertyKey key, PropertiesContext context, Method propertyMethod)
Default constructor.

Method Summary

DocumentName	getDocumentName() Returns the name of the document that identifies the document uniquely within the context of the project.
PropertyProjectdoc	getProjectdocProperty(PropertyDescriptor descriptor, Locale locale) Returns the projectdoc information.
PropertySetProjectdoc	getProjectdocPropertySet(PropertyDescriptor descriptor, Locale locale) Returns the projectdoc information for property sets.
String	toString() Returns the string representation of the object.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetaInfDocumentMetaDataProxy

public MetaInfDocumentMetaDataProxy(PropertyKey key,
                                    PropertiesContext context,
                                    Method propertyMethod)
                             throws NullPointerException

Default constructor.

Parameters:

key - the property key to the method.

context - the properties context to fetch information from the META-INF folder. May be null.

propertyMethod - the method to use to fetch annotations in case the context is not to be used.

Throws:

NullPointerException - if key or propertyMethod is null.

Method Detail

getDocumentName

public DocumentName getDocumentName()

Returns the name of the document that identifies the document uniquely within the context of the project. It is used to select the projectdoc document in the META-INF folder.

Specified by:

getDocumentName in interface DocumentMetaDataProxy

Returns:

the name of the document that identifies the document uniquely within the context of the project.

getProjectdocPropertySet

public PropertySetProjectdoc getProjectdocPropertySet(PropertyDescriptor descriptor,
                                                      Locale locale)

Description copied from interface: DocumentMetaDataProxy

Returns the projectdoc information for property sets.

Specified by:

getProjectdocPropertySet in interface DocumentMetaDataProxy

Parameters:

descriptor - the descriptor of the property whose property set projectdoc is requested.

locale - the locale to select the projectdoc in a specific language.

Returns:

the property set projectdoc written for the given locale.

getProjectdocProperty

public PropertyProjectdoc getProjectdocProperty(PropertyDescriptor descriptor,
                                                Locale locale)

Description copied from interface: DocumentMetaDataProxy

Returns the projectdoc information.

Specified by:

getProjectdocProperty in interface DocumentMetaDataProxy

Parameters:

descriptor - the descriptor of the property whose property projectdoc is requested.

locale - the locale to select the projectdoc in a specific language.

Returns:

the projectdoc written for the given locale.

toString

public String toString()

Returns the string representation of the object.

Overrides:

toString in class Object

Returns:

the string representation of the object.