de.smartics.properties.report.data
Class ValueComment

java.lang.Object
  de.smartics.properties.report.data.ValueComment

public final class ValueComment
     
     

      
      extends 
      
      Object
     
     

Provides comments for the values of a property.

Constructor Summary

ValueComment(String summary)
Default constructor.

Method Summary

void	addValueComment(Object value, String comment) Adds the comment for the given value.
String	getSummary() Returns the summary of the type of the values.
String	getValueComment(Object value) Returns the comment for the given value.

Methods inherited from class java.lang.Object

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

Constructor Detail

ValueComment

public ValueComment(String summary)

Default constructor.

Parameters:

summary - the summary of the type of the values.

Method Detail

getSummary

public String getSummary()

Returns the summary of the type of the values. May be null.

Returns:

the summary of the type of the values.

addValueComment

public void addValueComment(Object value,
                            String comment)

Adds the comment for the given value.

Parameters:

value - the value whose comment is to be added.

comment - the comment to the value.

getValueComment

public String getValueComment(Object value)

Returns the comment for the given value.

Parameters:

value - the value whose comment is requested.

Returns:

the comment to the value or null if there is no comment for taht value.