com.atlassian.stash.rest.client.api.entity

Class Project

java.lang.Object

com.atlassian.stash.rest.client.api.entity.Project

public class Project
extends Object

Describes a project

Project is a group of repositories with common settings eg. permissions

Constructor Summary

Constructors

Constructor and Description
Project(String key, long id, String name, String description, boolean isPublic, boolean isPersonal, String type, String selfUrl)

Method Summary

Modifier and Type	Method and Description
String	getDescription()
long	getId()
String	getKey()
String	getName()
String	getSelfUrl() Retrieves the project's url ie.
String	getType() Retrieves the project's type.
boolean	isPersonal() Retrieves a flag indicating whether this project is a Stash user's personal project in the system.
boolean	isPublic() Retrieves a flag indicating whether this project is public.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Project

public Project(String key,
               long id,
               String name,
               @Nullable
               String description,
               boolean isPublic,
               boolean isPersonal,
               String type,
               String selfUrl)

Method Detail

getKey

public String getKey()

Returns:

the project's unique key

getId

public long getId()

Returns:

the project's ID, which represents its primary key.

getName

public String getName()

Returns:

the project's name

getDescription

@Nullable
public String getDescription()

Returns:

the project's description

isPublic

public 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.

Returns:

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

isPersonal

public boolean isPersonal()

Retrieves a flag indicating whether this project is a Stash user's personal project in the system.

Returns:

true if the project is a personal project, false otherwise

getType

public String getType()

Retrieves the project's type. As of writing it may be NORMAL or PERSONAL

Returns:

the type for this project

getSelfUrl

public String getSelfUrl()

Retrieves the project's url ie. url leading to Stash application project page

Returns:

the url for this project

toString

public String toString()

Overrides:

toString in class Object