Package com.google.gerrit.entities

Class AccessSection

java.lang.Object

com.google.gerrit.entities.AccessSection

All Implemented Interfaces:

Comparable<AccessSection>

public abstract class AccessSection
extends Object
implements Comparable<AccessSection>

Portion of a Project describing access rules.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AccessSection.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static String	ALL	Pattern that matches all references in a project.
static String	GLOBAL_CAPABILITIES	Special name given to the global capabilities; not a valid reference.
static String	HEADS	Pattern that matches all branches in a project.
static String	REGEX_PREFIX	Prefix that triggers a regular expression pattern.

Constructor Summary

Constructors

Constructor	Description
AccessSection()

Method Summary

Modifier and Type	Method	Description
protected abstract AccessSection.Builder	autoToBuilder()
static AccessSection.Builder	builder(String name)
int	compareTo(AccessSection o)
static AccessSection	create(String name)
abstract String	getName()	Name of the access section.
Optional<Pattern>	getNamePattern()	A compiled regular expression in case getName() is a regular expression.
Permission	getPermission(String name)
abstract com.google.common.collect.ImmutableList<Permission>	getPermissions()
static boolean	isValidRefSectionName(String name)	Returns true if the name is likely to be a valid reference section name.
AccessSection.Builder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

GLOBAL_CAPABILITIES

public static final String GLOBAL_CAPABILITIES

Special name given to the global capabilities; not a valid reference.

See Also:

Constant Field Values

ALL

public static final String ALL

Pattern that matches all references in a project.

See Also:

Constant Field Values

HEADS

public static final String HEADS

Pattern that matches all branches in a project.

See Also:

Constant Field Values

REGEX_PREFIX

public static final String REGEX_PREFIX

Prefix that triggers a regular expression pattern.

See Also:

Constant Field Values

Constructor Detail

AccessSection

public AccessSection()

Method Detail

getName

public abstract String getName()

Name of the access section. It could be a ref pattern or something else.

getNamePattern

@Memoized
public Optional<Pattern> getNamePattern()

A compiled regular expression in case getName() is a regular expression. This is memoized to save callers from compiling patterns for every use.

getPermissions

public abstract com.google.common.collect.ImmutableList<Permission> getPermissions()

create

public static AccessSection create(String name)

builder

public static AccessSection.Builder builder(String name)

isValidRefSectionName

public static boolean isValidRefSectionName(String name)

Returns true if the name is likely to be a valid reference section name.

getPermission

public Permission getPermission(String name)

compareTo

public final int compareTo(AccessSection o)

Specified by:

compareTo in interface Comparable<AccessSection>

toString

public final String toString()

Overrides:

toString in class Object

toBuilder

public AccessSection.Builder toBuilder()

autoToBuilder

protected abstract AccessSection.Builder autoToBuilder()