org.lenskit.util.describe

Class AbstractDescriptionWriter

java.lang.Object

org.lenskit.util.describe.AbstractDescriptionWriter

All Implemented Interfaces:

DescriptionWriter

Direct Known Subclasses:

HashDescriptionWriter, StringDescriptionWriter

public abstract class AbstractDescriptionWriter
extends java.lang.Object
implements DescriptionWriter

Base class to help implementing DescriptionWriters.

Since:

2.1

Constructor Summary

Constructors

Constructor and Description
AbstractDescriptionWriter()

Method Summary

Modifier and Type	Method and Description
DescriptionWriter	putField(java.lang.String name, java.lang.Object value) Put an object field into the description.
DescriptionWriter	putList(java.lang.String name, java.lang.Iterable<?> objects) Put a field with a list of values, using the default describer.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.lenskit.util.describe.DescriptionWriter

putField, putField, putField, putField, putField, putList

Constructor Detail

AbstractDescriptionWriter

public AbstractDescriptionWriter()

Method Detail

putField

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

Description copied from interface: DescriptionWriter

Put an object field into the description.

Specified by:

putField in interface DescriptionWriter

Parameters:

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

value - The field value. It is described with Descriptions.defaultDescriber()}.

putList

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

Description copied from interface: DescriptionWriter

Put a field with a list of values, using the default describer.

Specified by:

putList in interface DescriptionWriter

Parameters:

name - The field name.

objects - The list of objects.

Returns:

The description writer (for chaining).