de.smartics.properties.spi.core.metadata
Interface PropertyCommentProvider

All Superinterfaces:

Serializable

All Known Implementing Classes:

PropertyCommentProxy

public interface PropertyCommentProvider
     
     

      
      extends 
      
      Serializable
     
     

Provides access to the comment of a property.

Method Summary

PropertyComment

getComment(PropertyDescriptor propertyDescriptor, Locale locale) Returns the comment for the given property descriptor.

Method Detail

getComment

PropertyComment getComment(PropertyDescriptor propertyDescriptor,
                           Locale locale)

Returns the comment for the given property descriptor.

Parameters:

propertyDescriptor - the descriptor for which the comment is requested. It is required that this is the same for each invocation.

locale - the locale to select the language the comment is written in.

Returns:

the property comment for the given descriptor.