help.de.smartics.properties.core
Class PropertyValueCommentBuilder

java.lang.Object
  help.de.smartics.properties.core.PropertyValueCommentBuilder

public final class PropertyValueCommentBuilder
     
     

      
      extends 
      
      Object
     
     

Builds instances of PropertyValueComments for tests.

Field Summary

static String	DEFAULT_SUMMARY
static String	DEFAULT_VALUE
static String	DEFAULT_VALUE_COMMENT

Method Summary

static PropertyValueCommentBuilder	a() Creates a builder filled with default values.
PropertyValueCommentBuilder	addValueComment(Serializable value, String comment) Adds the comment for the given value.
PropertyValueComment	build() Creates the instance.
PropertyValueCommentBuilder	but() Clones the builder.
static PropertyValueComment	defaultValueComment() Creates a default instance filled with default values.
static PropertyValueCommentBuilder	from(PropertyValueComment instance) Creates a builder from the instance.
PropertyValueCommentBuilder	withSummary(String summary) Sets the summary of the type of the values.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SUMMARY

public static final String DEFAULT_SUMMARY

Constant Field Value:

"Default summary comment."

DEFAULT_VALUE

public static final String DEFAULT_VALUE

Constant Field Value:

"value"

DEFAULT_VALUE_COMMENT

public static final String DEFAULT_VALUE_COMMENT

Constant Field Value:

"Comment to the value."

Method Detail

withSummary

public PropertyValueCommentBuilder withSummary(String summary)

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

Parameters:

propertySet - the summary of the type of the values. May be null.

Returns:

a reference to this builder.

addValueComment

public PropertyValueCommentBuilder addValueComment(Serializable 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.

Returns:

a reference to this builder.

defaultValueComment

public static PropertyValueComment defaultValueComment()

Creates a default instance filled with default values.

Returns:

an instance filled with default values.

See Also:

a()

a

public static PropertyValueCommentBuilder a()

Creates a builder filled with default values.

Returns:

a builder filled with default values.

See Also:

DEFAULT_SUMMARY, DEFAULT_VALUE, DEFAULT_VALUE_COMMENT

but

public PropertyValueCommentBuilder but()

Clones the builder.

Returns:

the cloned builder.

from

public static PropertyValueCommentBuilder from(PropertyValueComment instance)

Creates a builder from the instance.

Parameters:

instance - the instance to fill the builder.

Returns:

the builder initialized with information from the instance.

build

public PropertyValueComment build()

Creates the instance.

Returns:

the instance.