org.wikidata.wdtk.datamodel.helpers

Class EntityUpdateBuilder

java.lang.Object

org.wikidata.wdtk.datamodel.helpers.EntityUpdateBuilder

Direct Known Subclasses:

StatementDocumentUpdateBuilder

public abstract class EntityUpdateBuilder
extends Object

Builder for incremental construction of EntityUpdate objects.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EntityUpdateBuilder(EntityDocument revision) Initializes new builder object for constructing update of given base entity revision.
protected	EntityUpdateBuilder(EntityIdValue entityId, long revisionId) Initializes new builder object for constructing update of entity with given ID.

Method Summary

Modifier and Type	Method and Description
abstract EntityUpdate	build() Creates new EntityUpdate object with contents of this builder object.
static EntityUpdateBuilder	forBaseRevision(EntityDocument revision) Creates new builder object for constructing update of given base entity revision.
static EntityUpdateBuilder	forBaseRevisionId(EntityIdValue entityId, long revisionId) Creates new builder object for constructing update of entity with given revision ID.
static EntityUpdateBuilder	forEntityId(EntityIdValue entityId) Creates new builder object for constructing update of entity with given ID.

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityUpdateBuilder

protected EntityUpdateBuilder(EntityIdValue entityId,
                              long revisionId)

Initializes new builder object for constructing update of entity with given ID.

Parameters:

entityId - ID of the entity that is to be updated

revisionId - ID of the base entity revision to be updated or zero if not available

Throws:

NullPointerException - if entityId is null

IllegalArgumentException - if entityId is as placeholder ID

EntityUpdateBuilder

protected EntityUpdateBuilder(EntityDocument revision)

Initializes new builder object for constructing update of given base entity revision.

Parameters:

revision - base entity revision to be updated

Throws:

NullPointerException - if revision is null

IllegalArgumentException - if revision has a placeholder ID

Method Detail

forBaseRevisionId

public static EntityUpdateBuilder forBaseRevisionId(EntityIdValue entityId,
                                                    long revisionId)

Creates new builder object for constructing update of entity with given revision ID.

Supported entity IDs include ItemIdValue, PropertyIdValue, LexemeIdValue, FormIdValue, SenseIdValue, and MediaInfoIdValue.

Parameters:

entityId - ID of the entity that is to be updated

revisionId - ID of the base entity revision to be updated or zero if not available

Returns:

builder object matching entity type

Throws:

NullPointerException - if entityId is null

IllegalArgumentException - if entityId is of unrecognized type or it's a placeholder ID

forEntityId

public static EntityUpdateBuilder forEntityId(EntityIdValue entityId)

Creates new builder object for constructing update of entity with given ID.

Supported entity IDs include ItemIdValue, PropertyIdValue, LexemeIdValue, FormIdValue, SenseIdValue, and MediaInfoIdValue.

Parameters:

entityId - ID of the entity that is to be updated

Returns:

builder object matching entity type

Throws:

NullPointerException - if entityId is null

IllegalArgumentException - if entityId is of unrecognized type or it's a placeholder ID

forBaseRevision

public static EntityUpdateBuilder forBaseRevision(EntityDocument revision)

Creates new builder object for constructing update of given base entity revision. Provided entity document might not represent the latest revision of the entity as currently stored in Wikibase. It will be used for validation in builder methods. If the document has revision ID, it will be used to detect edit conflicts.

Supported entity types include ItemDocument, PropertyDocument, LexemeDocument, FormDocument, SenseDocument, and MediaInfoDocument.

Parameters:

revision - base entity revision to be updated

Returns:

builder object matching entity type

Throws:

NullPointerException - if revision is null

IllegalArgumentException - if revision is of unrecognized type or its ID is a placeholder ID

build

public abstract EntityUpdate build()

Creates new EntityUpdate object with contents of this builder object.

Returns:

constructed object