Package com.google.gerrit.server.group.db

Class InternalGroupUpdate

java.lang.Object

com.google.gerrit.server.group.db.InternalGroupUpdate

public abstract class InternalGroupUpdate
extends Object

Definition of an update to a group.

An InternalGroupUpdate only specifies the modifications which should be applied to a group. Each of the modifications and hence each call on InternalGroupUpdate.Builder is optional.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InternalGroupUpdate.Builder	A builder for an InternalGroupUpdate.
static interface	InternalGroupUpdate.MemberModification	Representation of a member modification as defined by InternalGroupUpdate.MemberModification.apply(ImmutableSet).
static interface	InternalGroupUpdate.SubgroupModification

Constructor Summary

Constructors

Constructor	Description
InternalGroupUpdate()

Method Summary

Modifier and Type	Method	Description
static InternalGroupUpdate.Builder	builder()
abstract Optional<String>	getDescription()	Defines the new description of the group.
abstract InternalGroupUpdate.MemberModification	getMemberModification()	Defines how the members of the group should be modified.
abstract Optional<AccountGroup.NameKey>	getName()	Defines the new name of the group.
abstract Optional<AccountGroup.UUID>	getOwnerGroupUUID()	Defines the new owner of the group.
abstract InternalGroupUpdate.SubgroupModification	getSubgroupModification()	Defines how the subgroups of the group should be modified.
abstract Optional<Timestamp>	getUpdatedOn()	Defines the Timestamp to be used for the NoteDb commits of the update.
abstract Optional<Boolean>	getVisibleToAll()	Defines the new state of the 'visibleToAll' flag of the group.
abstract InternalGroupUpdate.Builder	toBuilder()

Methods inherited from class java.lang.Object

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

Constructor Detail

InternalGroupUpdate

public InternalGroupUpdate()

Method Detail

getName

public abstract Optional<AccountGroup.NameKey> getName()

Defines the new name of the group. If not specified, the name remains unchanged.

getDescription

public abstract Optional<String> getDescription()

Defines the new description of the group. If not specified, the description remains unchanged.

Note: Passing the empty string unsets the description.

getOwnerGroupUUID

public abstract Optional<AccountGroup.UUID> getOwnerGroupUUID()

Defines the new owner of the group. If not specified, the owner remains unchanged.

getVisibleToAll

public abstract Optional<Boolean> getVisibleToAll()

Defines the new state of the 'visibleToAll' flag of the group. If not specified, the flag remains unchanged.

getMemberModification

public abstract InternalGroupUpdate.MemberModification getMemberModification()

Defines how the members of the group should be modified. By default (that is if nothing is specified), the members remain unchanged.

Returns:

a InternalGroupUpdate.MemberModification which gets the current members of the group as input and outputs the desired resulting members

getSubgroupModification

public abstract InternalGroupUpdate.SubgroupModification getSubgroupModification()

Defines how the subgroups of the group should be modified. By default (that is if nothing is specified), the subgroups remain unchanged.

Returns:

a InternalGroupUpdate.SubgroupModification which gets the current subgroups of the group as input and outputs the desired resulting subgroups

getUpdatedOn

public abstract Optional<Timestamp> getUpdatedOn()

Defines the Timestamp to be used for the NoteDb commits of the update. If not specified, the current Timestamp when creating the commit will be used.

If this InternalGroupUpdate is passed next to an InternalGroupCreation during a group creation, this Timestamp is used for the NoteDb commits of the new group. Hence, the InternalGroup#getCreatedOn() field will match this Timestamp.

Note: Timestamps of NoteDb commits for groups are used for events in the audit log. For this reason, specifying this field will have an effect on the resulting audit log.

toBuilder

public abstract InternalGroupUpdate.Builder toBuilder()

builder

public static InternalGroupUpdate.Builder builder()