com.google.enterprise.connector.util.diffing

Class GenericDocument

java.lang.Object

com.google.enterprise.connector.util.diffing.GenericDocument

All Implemented Interfaces:

Document

public class GenericDocument
extends java.lang.Object
implements Document

An generic implementation of Document.

Since:

2.8

Constructor Summary

Constructors

Constructor and Description
GenericDocument() Constructs a document with no properties.

Method Summary

Modifier and Type	Method and Description
Property	findProperty(java.lang.String name) Finds a Property by name.
java.util.Set<java.lang.String>	getPropertyNames() Gets the set of names of all Properties in this Document.
void	release() Release any resources this document is holding.
void	setProperty(java.lang.String propertyName, java.util.Calendar calendar) Sets a date/time property for this document.
void	setProperty(java.lang.String propertyName, java.io.InputStream propertyValue) Sets a property of type InputStream for this Document.
void	setProperty(java.lang.String propertyName, java.util.List<java.lang.String> propertyValues) Sets a multi-valued String property for this Document.
void	setProperty(java.lang.String propertyName, java.lang.String propertyValue) Sets a property for this Document.

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericDocument

public GenericDocument()

Constructs a document with no properties.

Method Detail

setProperty

public void setProperty(java.lang.String propertyName,
                        java.lang.String propertyValue)

Sets a property for this Document. If propertyValue is null, this does nothing.

Parameters:

propertyName - the property name

propertyValue - the property value, as a String

setProperty

public void setProperty(java.lang.String propertyName,
                        java.util.Calendar calendar)

Sets a date/time property for this document. If calendar is null, this does nothing.

Parameters:

propertyName - the property name

calendar - the property value, as a Calendar

setProperty

public void setProperty(java.lang.String propertyName,
                        java.io.InputStream propertyValue)

Sets a property of type InputStream for this Document. However, if propertyValue is null, do nothing.

Parameters:

propertyName - the property name

propertyValue - the property value, as an InputStream

setProperty

public void setProperty(java.lang.String propertyName,
                        java.util.List<java.lang.String> propertyValues)

Sets a multi-valued String property for this Document. If the the property value List is null or empty, this does nothing.

Parameters:

propertyName - the property name

propertyValues - a List of property values

findProperty

public Property findProperty(java.lang.String name)

Description copied from interface: Document

Finds a Property by name. If the current document has a property then that property is returned.

Specified by:

findProperty in interface Document

Parameters:

name - the name of the Property to find

Returns:

the Property, if found; null otherwise

getPropertyNames

public java.util.Set<java.lang.String> getPropertyNames()

Description copied from interface: Document

Gets the set of names of all Properties in this Document.

Specified by:

getPropertyNames in interface Document

Returns:

the names, as a Set of Strings

release

public void release()

Release any resources this document is holding. This implementation does nothing.