com.nomagic.magicdraw.core.project

Class ProjectDescriptorsFactory

java.lang.Object

com.nomagic.magicdraw.core.project.ProjectDescriptorsFactory

@OpenApiAll
public class ProjectDescriptorsFactory
extends java.lang.Object

Factory for ProjectDescriptors creating.

Constructor Summary

Constructors

Constructor and Description
ProjectDescriptorsFactory()

Method Summary

Modifier and Type	Method and Description
static java.net.URI	constructRemoteURI(java.lang.String id, java.lang.String qualifiedName) Creates project URI for remote project.
static java.net.URI	constructRemoteURI(java.lang.String id, java.lang.String qualifiedName, int version) Creates project URI for remote project and given version.
static java.net.URI	constructRemoteURI(java.lang.String id, java.lang.String qualifiedName, java.lang.String version) Creates project URI for remote project and given version.
static ProjectDescriptor	createAbstractRemoteProjectDescriptor(Project project) Deprecated. use createAnyRemoteProjectDescriptor
static AbstractRemoteProjectDescriptor	createAbstractRemoteProjectDescriptorWithActualVersion(Project project) Creates remote project descriptor.
static ProjectDescriptor	createAnyRemoteProjectDescriptor(Project project) Creates remote project descriptor.
static ProjectDescriptor	createLocalProjectDescriptor(Project project) Creates local project descriptor.
static ProjectDescriptor	createLocalProjectDescriptor(Project project, java.io.File file) Creates local project descriptor with given project and file
static ProjectDescriptor	createProjectDescriptor(java.lang.String location) Deprecated. Use createProjectDescriptor(URI) Parses location String and creates ProjectDescriptor object from project's location string.
static ProjectDescriptor	createProjectDescriptor(java.net.URI location) Parses location String and creates ProjectDescriptor object from project's location string.
static RemoteProjectDescriptor	createRemoteProjectDescriptor(Project project) Creates remote teamwork project descriptor.
static RemoteProjectDescriptor	createRemoteProjectDescriptor(java.lang.String id, java.lang.String qualifiedName) Creates project descriptor for remote project.
static ProjectDescriptor	createRemoteProjectDescriptor(java.lang.String id, java.lang.String qualifiedName, int actualVersionNumber) Creates project descriptor for remote project and given version.
static ProjectDescriptor	createRemoteProjectDescriptor(java.lang.String id, java.lang.String qualifiedName, java.lang.String actualVersionNumber) Creates project descriptor for remote project and given version.
static RemoteProjectDescriptor	createRemoteProjectDescriptorWithActualVersion(Project project) Creates remote teamwork project descriptor.
static java.util.List<ProjectDescriptor>	getAvailableDescriptorsForProject(Project project) Returns all available descriptors for given project.
static ProjectDescriptor	getDescriptorForProject(Project project) Returns project descriptor for given project
static java.lang.String	getName(java.net.URI uri) Retrieves project name from given uri.
static java.lang.String	getProjectBranchPath(java.net.URI uri) Get project branch path (without project name) or null if branches are not applicable for given uri
static java.lang.String	getProjectFullPath(java.net.URI uri) Get project branch path (WITH project name) or just project name if branches are not applicable for given uri
static java.lang.String	getProjectName(java.net.URI uri) Extract project name from the URI.
static java.lang.String	getRemoteID(java.net.URI uri) Retrieves project id from given uri.
static java.lang.String	getRemoteID(java.net.URI uri, java.lang.String separator) Retrieves project id from given uri.
static java.lang.String	getRemoteSeparator(java.net.URI uri)
static int	getRemoteVersion(java.net.URI uri) Retrieves remote version from given uri.
static java.lang.String	getRemoteVersionAsString(java.net.URI uri) Retrieves remote version from given uri.
static boolean	isAnyRemote(java.net.URI uri)
static boolean	isRemote(java.net.URI uri)

Methods inherited from class java.lang.Object

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

Constructor Detail

ProjectDescriptorsFactory

public ProjectDescriptorsFactory()

Method Detail

createProjectDescriptor

@CheckForNull
 @Deprecated
 @CheckReturnValue
public static ProjectDescriptor createProjectDescriptor(java.lang.String location)

Deprecated. Use createProjectDescriptor(URI) Parses location String and creates ProjectDescriptor object from project's location string.

Parameters:

location - the project's location

Returns:

constructed ProjectDescriptor object.

createProjectDescriptor

@CheckForNull
 @CheckReturnValue
public static ProjectDescriptor createProjectDescriptor(@CheckForNull
                                                                                         java.net.URI location)

Parses location String and creates ProjectDescriptor object from project's location string.

Parameters:

location - the project's location

Returns:

constructed ProjectDescriptor object.

getAvailableDescriptorsForProject

@CheckReturnValue
public static java.util.List<ProjectDescriptor> getAvailableDescriptorsForProject(Project project)

Returns all available descriptors for given project.

Parameters:

project - the project.

Returns:

List of descriptors.

getDescriptorForProject

@CheckReturnValue
public static ProjectDescriptor getDescriptorForProject(Project project)

Returns project descriptor for given project

Parameters:

project - project for which descriptor is created.

Returns:

Local project descriptor if project is local, remote project descriptor if project is remote.

createLocalProjectDescriptor

@CheckReturnValue
public static ProjectDescriptor createLocalProjectDescriptor(Project project)

Creates local project descriptor.

Parameters:

project - project for which descriptor is created.

Returns:

created project descriptor

createLocalProjectDescriptor

@CheckReturnValue
public static ProjectDescriptor createLocalProjectDescriptor(@CheckForNull
                                                                               Project project,
                                                                               @CheckForNull
                                                                               java.io.File file)

Creates local project descriptor with given project and file

Parameters:

project - project for which descriptor is created

file - new location for project

Returns:

created project descriptor.

createRemoteProjectDescriptor

@CheckForNull
 @CheckReturnValue
public static RemoteProjectDescriptor createRemoteProjectDescriptor(Project project)

Creates remote teamwork project descriptor.

Parameters:

project - project for which descriptor is created.

Returns:

null if project is not remote teamwork project.

createAnyRemoteProjectDescriptor

@CheckForNull
 @CheckReturnValue
public static ProjectDescriptor createAnyRemoteProjectDescriptor(Project project)

Creates remote project descriptor. Supports teamwork and ESI projects

Parameters:

project - project for which descriptor is created.

Returns:

null if project is not remote

createAbstractRemoteProjectDescriptor

@Deprecated
 @CheckForNull
 @CheckReturnValue
public static ProjectDescriptor createAbstractRemoteProjectDescriptor(Project project)

Deprecated. use createAnyRemoteProjectDescriptor

Creates remote project descriptor.

Parameters:

project - project for which descriptor is created.

Returns:

null if project is not remote

createRemoteProjectDescriptorWithActualVersion

@CheckForNull
 @CheckReturnValue
public static RemoteProjectDescriptor createRemoteProjectDescriptorWithActualVersion(Project project)

Creates remote teamwork project descriptor. Even for latest version uses actual version number instead of -1.

Parameters:

project - project for which descriptor is created.

Returns:

null if project is not remote teamwork project.

createAbstractRemoteProjectDescriptorWithActualVersion

@CheckForNull
 @CheckReturnValue
public static AbstractRemoteProjectDescriptor createAbstractRemoteProjectDescriptorWithActualVersion(Project project)

Creates remote project descriptor. Even for latest version uses actual version number instead of -1.

Parameters:

project - project for which descriptor is created.

Returns:

null if project is not remote

createRemoteProjectDescriptor

@CheckForNull
 @CheckReturnValue
public static RemoteProjectDescriptor createRemoteProjectDescriptor(java.lang.String id,
                                                                                                     java.lang.String qualifiedName)

Creates project descriptor for remote project.

Parameters:

id - remote project id.

qualifiedName - qualified name - branch (if any) combination with project name. See com.nomagic.teamwork.muserver.projects.ProjectsManagerHelper

Returns:

created descriptor.

constructRemoteURI

@CheckForNull
 @CheckReturnValue
public static java.net.URI constructRemoteURI(java.lang.String id,
                                                                               @CheckForNull
                                                                               java.lang.String qualifiedName,
                                                                               @CheckForNull
                                                                               java.lang.String version)

Creates project URI for remote project and given version.

Parameters:

id - remote project id.

qualifiedName - qualified name - branch (if any) combination with project name. See com.nomagic.teamwork.muserver.projects.ProjectsManagerHelper

version - version number for which descriptor is created. Use -1 for latest version.

Returns:

created uri.

constructRemoteURI

@CheckForNull
 @CheckReturnValue
public static java.net.URI constructRemoteURI(java.lang.String id,
                                                                               java.lang.String qualifiedName,
                                                                               int version)

Creates project URI for remote project and given version.

Parameters:

id - remote project id.

qualifiedName - qualified name - branch (if any) combination with project name. See com.nomagic.teamwork.muserver.projects.ProjectsManagerHelper

version - version number for which descriptor is created. Use -1 for latest version.

Returns:

created uri.

constructRemoteURI

@CheckForNull
 @CheckReturnValue
public static java.net.URI constructRemoteURI(java.lang.String id,
                                                                               java.lang.String qualifiedName)

Creates project URI for remote project.

Parameters:

id - remote project id.

qualifiedName - qualified name - branch (if any) combination with project name. See com.nomagic.teamwork.muserver.projects.ProjectsManagerHelper

Returns:

created uri.

getRemoteVersionAsString

@CheckForNull
 @CheckReturnValue
public static java.lang.String getRemoteVersionAsString(java.net.URI uri)

Retrieves remote version from given uri.

Parameters:

uri - uri to check

Returns:

version number from uri.

getRemoteVersion

@CheckReturnValue
public static int getRemoteVersion(java.net.URI uri)

Retrieves remote version from given uri.

Parameters:

uri - uri to check

Returns:

version number from uri.

isRemote

@CheckReturnValue
public static boolean isRemote(java.net.URI uri)

Parameters:

uri - uri to check.

Returns:

true if uri is remote project descriptor uri

isAnyRemote

@CheckReturnValue
public static boolean isAnyRemote(java.net.URI uri)

Parameters:

uri - uri to check.

Returns:

true if uri is remote project descriptor uri

getRemoteID

@CheckForNull
 @CheckReturnValue
public static java.lang.String getRemoteID(java.net.URI uri)

Retrieves project id from given uri.

Parameters:

uri - remote project uri to check.

Returns:

remote project id from project uri.

getRemoteID

@CheckForNull
 @CheckReturnValue
public static java.lang.String getRemoteID(java.net.URI uri,
                                                                            java.lang.String separator)

Retrieves project id from given uri.

Parameters:

uri - remote project uri to check.

separator - uri info separator

Returns:

remote project id from project uri.

getName

@CheckForNull
public static java.lang.String getName(@CheckForNull
                                                     java.net.URI uri)

Retrieves project name from given uri.

Parameters:

uri - remote uri to check.

Returns:

remote project name.

getProjectName

@CheckForNull
 @CheckReturnValue
public static java.lang.String getProjectName(java.net.URI uri)

Extract project name from the URI. Name doesn't contain branch name, if such was (remote)

Parameters:

uri - uri used to retrieve name.

Returns:

project name

See Also:

getName(java.net.URI)

getProjectBranchPath

@CheckForNull
 @CheckReturnValue
public static java.lang.String getProjectBranchPath(java.net.URI uri)

Get project branch path (without project name) or null if branches are not applicable for given uri

Parameters:

uri - used to retrieve path.

Returns:

null if no branch was found

getProjectFullPath

@CheckForNull
 @CheckReturnValue
public static java.lang.String getProjectFullPath(java.net.URI uri)

Get project branch path (WITH project name) or just project name if branches are not applicable for given uri

Parameters:

uri - used to retrieve full path.

Returns:

null if no branch was found

createRemoteProjectDescriptor

@CheckForNull
 @CheckReturnValue
public static ProjectDescriptor createRemoteProjectDescriptor(java.lang.String id,
                                                                                               @CheckForNull
                                                                                               java.lang.String qualifiedName,
                                                                                               @CheckForNull
                                                                                               java.lang.String actualVersionNumber)

Creates project descriptor for remote project and given version.

Parameters:

id - remote project id.

qualifiedName - qualified name - branch (if any) combination with project name.

actualVersionNumber - version number for which descriptor is created. Use -1 for latest version.

Returns:

created descriptor.

createRemoteProjectDescriptor

@CheckForNull
 @CheckReturnValue
public static ProjectDescriptor createRemoteProjectDescriptor(java.lang.String id,
                                                                                               @CheckForNull
                                                                                               java.lang.String qualifiedName,
                                                                                               int actualVersionNumber)

Creates project descriptor for remote project and given version.

Parameters:

id - remote project id.

qualifiedName - qualified name - branch (if any) combination with project name.

actualVersionNumber - version number for which descriptor is created. Use -1 for latest version.

Returns:

created descriptor.

getRemoteSeparator

public static java.lang.String getRemoteSeparator(java.net.URI uri)

Parameters:

uri - uri.

Returns:

separator used for splitting uri into parts