de.smartics.properties.spi.core.metadata.comment
Class PropertyCommentParser

java.lang.Object
  de.smartics.properties.spi.core.metadata.comment.PropertyCommentParser

public final class PropertyCommentParser
     
     

      
      extends 
      
      Object
     
     

Parses property comments for a property descriptors.

Constructor Summary

PropertyCommentParser(PropertiesContext context)
Default constructor.

Method Summary

PropertyComment

parse(PropertyDescriptor descriptor, Locale locale) Parses the comments for the given descriptor.

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyCommentParser

public PropertyCommentParser(PropertiesContext context)
                      throws de.smartics.util.lang.NullArgumentException

Default constructor.

Parameters:

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

Throws:

de.smartics.util.lang.NullArgumentException - if context is null.

Method Detail

parse

public PropertyComment parse(PropertyDescriptor descriptor,
                             Locale locale)

Parses the comments for the given descriptor.

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.