de.smartics.properties.api.core.domain
Class PropertyComment

java.lang.Object
  de.smartics.properties.api.core.domain.PropertyComment

All Implemented Interfaces:

Serializable

public final class PropertyComment
     
     

      
      extends 
      
      Object
     
     
     
     

      
      implements 
      
      Serializable
     
     

The comment to a property.

See Also:

Serialized Form

Nested Class Summary

static class

PropertyComment.Builder The property comment instance builder.

Field Summary

static PropertyComment

EMPTY_COMMENT The empty comment instance.

Method Summary

String	getText() Returns the text of the comment.
PropertyValueComment	getValueComment() Returns the comment of the property values.
String	toString() Returns the comment text.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_COMMENT

public static final PropertyComment EMPTY_COMMENT

The empty comment instance. Can be used if no comment for a property is accessible.

Method Detail

getText

public String getText()

Returns the text of the comment.

Returns:

the text of the comment.

getValueComment

public PropertyValueComment getValueComment()

Returns the comment of the property values.

Returns:

the comment of the property values.

toString

public String toString()

Returns the comment text.

Overrides:

toString in class Object

Returns:

the comment text.