org.lenskit.util.describe

Class StringDescriptionWriter

java.lang.Object

org.lenskit.util.describe.AbstractDescriptionWriter

org.lenskit.util.describe.StringDescriptionWriter

All Implemented Interfaces:

DescriptionWriter

public class StringDescriptionWriter
extends AbstractDescriptionWriter

Description writer that accumulates a string.

Method Summary

Modifier and Type	Method and Description
java.lang.String	finish() Get the accumulated string description.
DescriptionWriter	putField(java.lang.String name, byte[] value) Put a byte array field.
DescriptionWriter	putField(java.lang.String name, double value) Put a floating-point field.
DescriptionWriter	putField(java.lang.String name, long value) Put an integer field.
DescriptionWriter	putField(java.lang.String name, java.lang.String value) Put a field into the description.
<T> DescriptionWriter	putField(java.lang.String name, T value, Describer<? super T> describer) Put an object field into the description.
<T> DescriptionWriter	putList(java.lang.String name, java.lang.Iterable<T> objects, Describer<? super T> describer) Put a field with a list of values.

Methods inherited from class org.lenskit.util.describe.AbstractDescriptionWriter

putField, putList

Methods inherited from class java.lang.Object

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

Method Detail

finish

public java.lang.String finish()

Get the accumulated string description.

Returns:

The accumulated string description.

putField

public DescriptionWriter putField(java.lang.String name,
                                  java.lang.String value)

Description copied from interface: DescriptionWriter

Put a field into the description.

Parameters:

name - The field name. It cannot begin with an underscore.

value - The field value.

putField

public DescriptionWriter putField(java.lang.String name,
                                  long value)

Description copied from interface: DescriptionWriter

Put an integer field.

Parameters:

name - The field name.

value - The field value.

See Also:

DescriptionWriter.putField(String, String)

putField

public DescriptionWriter putField(java.lang.String name,
                                  double value)

Description copied from interface: DescriptionWriter

Put a floating-point field.

Parameters:

name - The field name.

value - The field value.

See Also:

DescriptionWriter.putField(String, String)

putField

public DescriptionWriter putField(java.lang.String name,
                                  byte[] value)

Description copied from interface: DescriptionWriter

Put a byte array field.

Parameters:

name - The field name.

value - The field value.

See Also:

DescriptionWriter.putField(String, String)

putList

public <T> DescriptionWriter putList(java.lang.String name,
                                     java.lang.Iterable<T> objects,
                                     Describer<? super T> describer)

Description copied from interface: DescriptionWriter

Put a field with a list of values.

Parameters:

name - The field name.

objects - The list of objects.

describer - A describer for the objects.

Returns:

The description writer (for chaining).

putField

public <T> DescriptionWriter putField(java.lang.String name,
                                      T value,
                                      Describer<? super T> describer)

Description copied from interface: DescriptionWriter

Put an object field into the description.

Parameters:

name - The field name. It cannot begin with an underscore.

value - The field value. If it implements Describable, then it is asked to write its description; otherwise, some default behavior is used.

describer - A describer to describe the value.