de.smartics.properties.spi.core.metadata.projectdoc
Class PropertySetProjectdocParser

java.lang.Object
  de.smartics.properties.spi.core.metadata.projectdoc.ProjectdocMetaDataParser
      de.smartics.properties.spi.core.metadata.projectdoc.PropertySetProjectdocParser

public final class PropertySetProjectdocParser
     
     

      
      extends 
      
      ProjectdocMetaDataParser
     
     

Parsed projectdoc's property set documents.

Nested Class Summary

Nested classes/interfaces inherited from class de.smartics.properties.spi.core.metadata.projectdoc.ProjectdocMetaDataParser

ProjectdocMetaDataParser.ParserContext

Field Summary

protected static org.jdom.Namespace

NS The namespace of the XML files this parser can parse.

Fields inherited from class de.smartics.properties.spi.core.metadata.projectdoc.ProjectdocMetaDataParser

context, defaults

Constructor Summary

PropertySetProjectdocParser(PropertiesContext context)
Convenience constructor without defaults.

PropertySetProjectdocParser(PropertiesContext context, ProjectdocAnnotationCollector.Defaults defaults)
Default constructor.

Method Summary

protected String	calcPath(PropertyDescriptor descriptor, Locale locale) Calculates the path to a resource to be parsed.
protected org.jdom.Namespace	getNs() Returns the namespace of the elements parsed by this parser.
PropertySetProjectdoc	parse(PropertyDescriptor descriptor, Locale locale) Parses the comments for the given descriptor.
protected void	parseAdditional(ProjectdocMetaDataParser.ParserContext context) The hook that allows to add further information.

Methods inherited from class de.smartics.properties.spi.core.metadata.projectdoc.ProjectdocMetaDataParser

parseBase

Methods inherited from class java.lang.Object

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

Field Detail

NS

protected static final org.jdom.Namespace NS

The namespace of the XML files this parser can parse.

Constructor Detail

PropertySetProjectdocParser

public PropertySetProjectdocParser(PropertiesContext context)
                            throws NullPointerException

Convenience constructor without defaults.

Parameters:

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

Throws:

NullPointerException - if context is null.

PropertySetProjectdocParser

public PropertySetProjectdocParser(PropertiesContext context,
                                   ProjectdocAnnotationCollector.Defaults defaults)
                            throws NullPointerException

Default constructor.

Parameters:

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

defaults - the metadata defaults to use.

Throws:

NullPointerException - if context is null.

Method Detail

calcPath

protected String calcPath(PropertyDescriptor descriptor,
                          Locale locale)

Description copied from class: ProjectdocMetaDataParser

Calculates the path to a resource to be parsed.

Specified by:

calcPath in class ProjectdocMetaDataParser

Parameters:

descriptor - the descriptor to the resource.

locale - the requested locale.

Returns:

the path to the resource.

parse

public PropertySetProjectdoc parse(PropertyDescriptor descriptor,
                                   Locale locale)

Description copied from class: ProjectdocMetaDataParser

Parses the comments for the given descriptor.

This method is overridden by subclasses to return their specific implementation of the DocumentMetaData.

Overrides:

parse in class ProjectdocMetaDataParser

Parameters:

descriptor - the descriptor whose comments are requested to be parsed.

locale - the locale to select the comments.

Returns:

the comments for the given locale or the default comments, if the locale is not supported. May be null if no information is provided.

parseAdditional

protected void parseAdditional(ProjectdocMetaDataParser.ParserContext context)

Description copied from class: ProjectdocMetaDataParser

The hook that allows to add further information.

Overrides:

parseAdditional in class ProjectdocMetaDataParser

Parameters:

context - to provide access to information relevant for parsing and storing the parsed information.

getNs

protected org.jdom.Namespace getNs()

Description copied from class: ProjectdocMetaDataParser

Returns the namespace of the elements parsed by this parser.

Specified by:

getNs in class ProjectdocMetaDataParser

Returns:

the namespace of the elements parsed by this parser.