public abstract class StatementDocumentUpdateBuilder extends EntityUpdateBuilder
StatementDocumentUpdate
objects.StatementUpdateBuilder
Modifier | Constructor and Description |
---|---|
protected |
StatementDocumentUpdateBuilder(EntityIdValue entityId,
long revisionId)
Initializes new builder object for constructing update of entity with given
ID.
|
protected |
StatementDocumentUpdateBuilder(StatementDocument revision)
Initializes new builder object for constructing update of given base entity
revision.
|
Modifier and Type | Method and Description |
---|---|
abstract StatementDocumentUpdate |
build()
Creates new
StatementDocumentUpdate object with contents of this
builder object. |
static StatementDocumentUpdateBuilder |
forBaseRevision(StatementDocument revision)
Creates new builder object for constructing update of given base entity
revision.
|
static StatementDocumentUpdateBuilder |
forBaseRevisionId(EntityIdValue entityId,
long revisionId)
Creates new builder object for constructing update of entity with given
revision ID.
|
static StatementDocumentUpdateBuilder |
forEntityId(EntityIdValue entityId)
Creates new builder object for constructing update of entity with given ID.
|
StatementDocumentUpdateBuilder |
updateStatements(StatementUpdate update)
Updates entity statements.
|
forBaseRevision
protected StatementDocumentUpdateBuilder(EntityIdValue entityId, long revisionId)
entityId
- ID of the entity that is to be updatedrevisionId
- ID of the base entity revision to be updated or zero if not
availableNullPointerException
- if entityId
is null
IllegalArgumentException
- if entityId
is a placeholder IDprotected StatementDocumentUpdateBuilder(StatementDocument revision)
revision
- base entity revision to be updatedNullPointerException
- if revision
is null
IllegalArgumentException
- if revision
has placeholder IDpublic static StatementDocumentUpdateBuilder forBaseRevisionId(EntityIdValue entityId, long revisionId)
Supported entity IDs include ItemIdValue
, PropertyIdValue
,
LexemeIdValue
, FormIdValue
, SenseIdValue
, and
MediaInfoIdValue
.
entityId
- ID of the entity that is to be updatedrevisionId
- ID of the base entity revision to be updated or zero if not
availableNullPointerException
- if entityId
is null
IllegalArgumentException
- if entityId
is of unrecognized type or it is a
placeholder IDpublic static StatementDocumentUpdateBuilder forEntityId(EntityIdValue entityId)
Supported entity IDs include ItemIdValue
, PropertyIdValue
,
LexemeIdValue
, FormIdValue
, SenseIdValue
, and
MediaInfoIdValue
.
entityId
- ID of the entity that is to be updatedNullPointerException
- if entityId
is null
IllegalArgumentException
- if entityId
is of unrecognized type or it is a
placeholder IDpublic static StatementDocumentUpdateBuilder forBaseRevision(StatementDocument revision)
Supported entity types include ItemDocument
,
PropertyDocument
, LexemeDocument
, FormDocument
,
SenseDocument
, and MediaInfoDocument
.
revision
- base entity revision to be updatedNullPointerException
- if revision
is null
IllegalArgumentException
- if revision
is of unrecognized type or its ID is a
placeholder IDpublic StatementDocumentUpdateBuilder updateStatements(StatementUpdate update)
update
- statement update, possibly emptythis
(fluent method)NullPointerException
- if update
is null
IllegalArgumentException
- if replaced or removed statement is not present in current entity
revision (if available)public abstract StatementDocumentUpdate build()
StatementDocumentUpdate
object with contents of this
builder object.build
in class EntityUpdateBuilder
Copyright © 2014–2024 Wikidata Toolkit Developers. Generated from source code published under the Apache License 2.0. For more information, see the Wikidata Toolkit homepage