public abstract class LabeledDocumentUpdateBuilder extends StatementDocumentUpdateBuilder
LabeledStatementDocumentUpdate
objects.Modifier | Constructor and Description |
---|---|
protected |
LabeledDocumentUpdateBuilder(EntityIdValue entityId,
long revisionId)
Initializes new builder object for constructing update of entity with given
ID.
|
protected |
LabeledDocumentUpdateBuilder(LabeledStatementDocument revision)
Initializes new builder object for constructing update of given base entity
revision.
|
Modifier and Type | Method and Description |
---|---|
abstract LabeledStatementDocumentUpdate |
build()
Creates new
LabeledStatementDocumentUpdate object with contents of
this builder object. |
static LabeledDocumentUpdateBuilder |
forBaseRevision(LabeledStatementDocument revision)
Creates new builder object for constructing update of given base entity
revision.
|
static LabeledDocumentUpdateBuilder |
forBaseRevisionId(EntityIdValue entityId,
long revisionId)
Creates new builder object for constructing update of entity with given
revision ID.
|
static LabeledDocumentUpdateBuilder |
forEntityId(EntityIdValue entityId)
Creates new builder object for constructing update of entity with given ID.
|
LabeledDocumentUpdateBuilder |
updateLabels(TermUpdate update)
Updates entity labels.
|
LabeledDocumentUpdateBuilder |
updateStatements(StatementUpdate update)
Updates entity statements.
|
forBaseRevision
forBaseRevision
protected LabeledDocumentUpdateBuilder(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 LabeledDocumentUpdateBuilder(LabeledStatementDocument revision)
revision
- base entity revision to be updatedNullPointerException
- if revision
is null
IllegalArgumentException
- if revision
has placeholder IDpublic static LabeledDocumentUpdateBuilder forBaseRevisionId(EntityIdValue entityId, long revisionId)
Supported entity IDs include ItemIdValue
, PropertyIdValue
,
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 LabeledDocumentUpdateBuilder forEntityId(EntityIdValue entityId)
Supported entity IDs include ItemIdValue
, PropertyIdValue
,
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 LabeledDocumentUpdateBuilder forBaseRevision(LabeledStatementDocument revision)
Supported entity types include ItemDocument
,
PropertyDocument
, 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 LabeledDocumentUpdateBuilder updateStatements(StatementUpdate update)
StatementDocumentUpdateBuilder
updateStatements
in class StatementDocumentUpdateBuilder
update
- statement update, possibly emptythis
(fluent method)public LabeledDocumentUpdateBuilder updateLabels(TermUpdate update)
update
- changes in entity labelsthis
(fluent method)NullPointerException
- if update
is null
public abstract LabeledStatementDocumentUpdate build()
LabeledStatementDocumentUpdate
object with contents of
this builder object.build
in class StatementDocumentUpdateBuilder
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