com.atlassian.bitbucket.project

Interface Project

All Known Subinterfaces:

PersonalProject

public interface Project

Describes a project in the system.

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_REGEXP The regexp to validate the project key when creating or updating from an untrusted source.
static String	KEY_TRUSTED_REGEXP The regexp to validate the project key when creating or updating from a trusted source, which is slightly more relaxed than KEY_REGEXP.
static int	MAX_KEY_LENGTH The maximum length of a project key.
static int	MAX_NAME_LENGTH The maximum length of a project name.
static int	MAX_NAMESPACE_LENGTH The maximum length of a project namespace.
static String	NAME_REGEXP The regexp to validate the project name.
static String	NAMESPACE_REGEXP The regexp to validate the project namespace.

Method Summary

Modifier and Type	Method and Description
<T> T	accept(ProjectVisitor<T> visitor)
String	getDescription()
int	getId()
@Pattern(regexp="[a-zA-Z][a-zA-Z0-9_\\-]*",groups={Create.class,Update.class},message="{com.atlassian.bitbucket.validation.project.key.pattern.message}") @Pattern(regexp="~[a-zA-Z0-9\\-_.]+|[a-zA-Z][a-zA-Z0-9_\\-]*",groups={TrustedCreate.class,TrustedUpdate.class},message="{com.atlassian.bitbucket.validation.project.key.trusted.pattern.message}") String	getKey()
@Pattern(regexp="^[^~].*",groups={Create.class,Update.class},message="{com.atlassian.bitbucket.validation.project.name.pattern.message}") String	getName()
@Pattern(regexp="[a-zA-Z0-9_\\-]*",message="{com.atlassian.bitbucket.validation.project.namespace.pattern.message}") String	getNamespace()
ProjectType	getType() Retrieves the project's type.
boolean	isPublic() Retrieves a flag indicating whether this project is public.

Field Detail

KEY_REGEXP

static final String KEY_REGEXP

The regexp to validate the project key when creating or updating from an untrusted source.

See Also:

Constant Field Values

KEY_TRUSTED_REGEXP

static final String KEY_TRUSTED_REGEXP

The regexp to validate the project key when creating or updating from a trusted source, which is slightly more relaxed than KEY_REGEXP. This regexp allows PersonalProject keys (which must begin with tilda, and have less restrictions on which characters can be included) and normal project keys (represented by KEY_REGEXP, which must not begin with tilda).

See Also:

Constant Field Values

MAX_KEY_LENGTH

static final int MAX_KEY_LENGTH

The maximum length of a project key.

See Also:

Constant Field Values

MAX_NAME_LENGTH

static final int MAX_NAME_LENGTH

The maximum length of a project name.

Since:

4.10

See Also:

Constant Field Values

MAX_NAMESPACE_LENGTH

static final int MAX_NAMESPACE_LENGTH

The maximum length of a project namespace.

Since:

4.2

See Also:

Constant Field Values

NAME_REGEXP

static final String NAME_REGEXP

The regexp to validate the project name.

Since:

4.4

See Also:

Constant Field Values

NAMESPACE_REGEXP

static final String NAMESPACE_REGEXP

The regexp to validate the project namespace.

Since:

4.2

See Also:

Constant Field Values

Method Detail

accept

<T> T accept(@Nonnull
             ProjectVisitor<T> visitor)

Type Parameters:

T - type of visitor

Parameters:

visitor - the visitor to process the project instance

Returns:

a visitor of the supplied type

getDescription

@OptionalString(size=255)
String getDescription()

getId

int getId()

isPublic

boolean isPublic()

Retrieves a flag indicating whether this project is public.

Note, this flag is taken into account when calculating whether this project is accessible to unauthenticated users but is not the definitive answer. For a definitive answer, use isPubliclyAccessible.

Returns:

true if the project has been marked as public, false otherwise

getKey

@Pattern(regexp="[a-zA-Z][a-zA-Z0-9_\\-]*",groups={Create.class,Update.class},message="{com.atlassian.bitbucket.validation.project.key.pattern.message}") @Pattern(regexp="~[a-zA-Z0-9\\-_.]+|[a-zA-Z][a-zA-Z0-9_\\-]*",groups={TrustedCreate.class,TrustedUpdate.class},message="{com.atlassian.bitbucket.validation.project.key.trusted.pattern.message}")
 @RequiredString(size=128)
@Pattern(regexp="[a-zA-Z][a-zA-Z0-9_\\-]*",groups={Create.class,Update.class},message="{com.atlassian.bitbucket.validation.project.key.pattern.message}") @Pattern(regexp="~[a-zA-Z0-9\\-_.]+|[a-zA-Z][a-zA-Z0-9_\\-]*",groups={TrustedCreate.class,TrustedUpdate.class},message="{com.atlassian.bitbucket.validation.project.key.trusted.pattern.message}") String getKey()

getName

@Pattern(regexp="^[^~].*",
         groups={Create.class,Update.class},
         message="{com.atlassian.bitbucket.validation.project.name.pattern.message}")
 @RequiredString(size=128)
@Pattern(regexp="^[^~].*",groups={Create.class,Update.class},message="{com.atlassian.bitbucket.validation.project.name.pattern.message}") String getName()

getNamespace

@Pattern(regexp="[a-zA-Z0-9_\\-]*",
         message="{com.atlassian.bitbucket.validation.project.namespace.pattern.message}")
 @OptionalString(size=128)
@Pattern(regexp="[a-zA-Z0-9_\\-]*",message="{com.atlassian.bitbucket.validation.project.namespace.pattern.message}") String getNamespace()

Returns:

the project's namespace. Namespaces are only supported in mirror mode and will be null in standard installations.

Since:

4.2

getType

@Nonnull
ProjectType getType()

Retrieves the project's type. See the documentation for the various types to determine what interfaces each implements.

Returns:

the type for this project