Package org.wikidata.wdtk.datamodel.helpers

Class PropertyDocumentBuilder

java.lang.Object

org.wikidata.wdtk.datamodel.helpers.AbstractDataObjectBuilder<T,O>

org.wikidata.wdtk.datamodel.helpers.EntityDocumentBuilder<PropertyDocumentBuilder,PropertyDocument>

org.wikidata.wdtk.datamodel.helpers.PropertyDocumentBuilder

public class PropertyDocumentBuilder
extends EntityDocumentBuilder<PropertyDocumentBuilder,PropertyDocument>

Builder class to construct PropertyDocument objects.

Author:

Markus Kroetzsch

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PropertyDocumentBuilder(PropertyIdValue propertyIdValue, DatatypeIdValue datatype)	Constructor.

Method Summary

Modifier and Type	Method	Description
PropertyDocument	build()	Returns the ItemDocument that has been built.
static PropertyDocumentBuilder	forPropertyIdAndDatatype(PropertyIdValue propertyIdValue, java.lang.String datatypeId)	Starts the construction of an PropertyDocument with the given id.
static PropertyDocumentBuilder	forPropertyIdAndDatatype(PropertyIdValue propertyIdValue, DatatypeIdValue datatype)	Starts the construction of an PropertyDocument with the given id.
protected PropertyDocumentBuilder	getThis()	Returns the current object with the correct builder type.

Methods inherited from class org.wikidata.wdtk.datamodel.helpers.AbstractDataObjectBuilder

prepareBuild

Methods inherited from class org.wikidata.wdtk.datamodel.helpers.EntityDocumentBuilder

getStatementGroups, withAlias, withAlias, withDescription, withDescription, withLabel, withLabel, withRevisionId, withStatement

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyDocumentBuilder

protected PropertyDocumentBuilder(PropertyIdValue propertyIdValue,
                                  DatatypeIdValue datatype)

Constructor.

Parameters:

propertyIdValue - id of the newly constructed property document

datatype - the datatype of the newly constructed property document

Method Detail

forPropertyIdAndDatatype

public static PropertyDocumentBuilder forPropertyIdAndDatatype(PropertyIdValue propertyIdValue,
                                                               DatatypeIdValue datatype)

Starts the construction of an PropertyDocument with the given id.

Parameters:

propertyIdValue - id of the newly constructed property document

datatype - the datatype of the newly constructed property document

Returns:

builder object to continue construction

forPropertyIdAndDatatype

public static PropertyDocumentBuilder forPropertyIdAndDatatype(PropertyIdValue propertyIdValue,
                                                               java.lang.String datatypeId)

Starts the construction of an PropertyDocument with the given id.

Parameters:

propertyIdValue - id of the newly constructed property document

datatypeId - the datatype id of the newly constructed property document, e.g., DatatypeIdValue.DT_ITEM.

Returns:

builder object to continue construction

build

public PropertyDocument build()

Returns the ItemDocument that has been built.

Specified by:

build in class AbstractDataObjectBuilder<PropertyDocumentBuilder,PropertyDocument>

Returns:

constructed item document

Throws:

java.lang.IllegalStateException - if the object was built already

getThis

protected PropertyDocumentBuilder getThis()

Description copied from class: AbstractDataObjectBuilder

Returns the current object with the correct builder type.

Specified by:

getThis in class AbstractDataObjectBuilder<PropertyDocumentBuilder,PropertyDocument>

Returns:

this