Package com.nomagic.magicdraw.magicreport.tools

Class ProjectVersion

java.lang.Object

com.nomagic.magicdraw.magicreport.tools.ProjectVersion

@OpenApiAll
public class ProjectVersion
extends java.lang.Object

Version represents some version of the project.It has date, user and number.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProjectVersion.ProjectVersionAscendingSort	Sort Collection of ProjectVersion in ascending
static class	ProjectVersion.ProjectVersionDescendingSort	Sort Collection of ProjectVersion in descending

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ASCENDING
private java.lang.String	comment	the comment for version
private java.util.Date	date	The date of the version.
static java.lang.String	DESCENDING
private long	number	The number of the version.
private ProjectDescriptor	projectDescriptor	The project descriptor
private java.lang.String	user	The user of the version.
private java.lang.Object	version	The version object

Constructor Summary

Constructors

Constructor	Description
ProjectVersion(ProjectDescriptor projectDescriptor, java.lang.Object version, java.lang.String comment, java.util.Date date, long number, java.lang.String user)	Constructs new version with given projectDescriptor, version object, comment, user, number and date.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getAuthor()	Returns the user who created the version.
java.lang.String	getComment()
java.util.Date	getDate()	Returns the date of the version.
java.lang.String	getDateAsString()	Returns date represented by string.
long	getNumber()	Returns the number of the version.
java.lang.String	getNumberAsString()	Deprecated.
ProjectDescriptor	getProjectDescriptor()
java.util.List<java.lang.String>	getTags()	Returns all tags.
java.lang.String	getUser()	Returns the user who created the version.
java.lang.Object	getVersion()	Returns version object of project
java.lang.String	getVersionAsString()	Returns string representation about version number.
void	setComment(java.lang.String comment)	Sets comment text.
void	setDate(java.util.Date date)	Sets version date.
void	setNumber(long number)	Sets version number
void	setProjectDescriptor(ProjectDescriptor projectDescriptor)	Set project descriptor.
void	setUser(java.lang.String user)	Sets user for the version
void	setVersion(java.lang.Object version)	Sets version object

Methods inherited from class java.lang.Object

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

Field Detail

DESCENDING

public static final java.lang.String DESCENDING

See Also:

Constant Field Values

ASCENDING

public static final java.lang.String ASCENDING

See Also:

Constant Field Values

comment

private java.lang.String comment

the comment for version

date

private java.util.Date date

The date of the version.

number

private long number

The number of the version.

user

private java.lang.String user

The user of the version.

version

private java.lang.Object version

The version object

projectDescriptor

private ProjectDescriptor projectDescriptor

The project descriptor

Constructor Detail

ProjectVersion

public ProjectVersion(ProjectDescriptor projectDescriptor,
                      java.lang.Object version,
                      java.lang.String comment,
                      java.util.Date date,
                      long number,
                      java.lang.String user)

Constructs new version with given projectDescriptor, version object, comment, user, number and date.

Parameters:

projectDescriptor - Project Descriptor

version - version object

comment - comment of version

date - date of version

number - number of version

user - user of version

Method Detail

getComment

public java.lang.String getComment()

Returns:

comment for this version.

setComment

public void setComment(java.lang.String comment)

Sets comment text.

Parameters:

com - the comment text.

getDate

public java.util.Date getDate()

Returns the date of the version.

Returns:

the date.

setDate

public void setDate(java.util.Date date)

Sets version date.

Parameters:

date -

getNumber

public long getNumber()

Returns the number of the version.

Returns:

the number.

setNumber

public void setNumber(long number)

Sets version number

Parameters:

number -

getUser

public java.lang.String getUser()

Returns the user who created the version.

Returns:

the user who created the version.

getAuthor

public java.lang.String getAuthor()

Returns the user who created the version.

Returns:

the user who created the version.

setUser

public void setUser(java.lang.String user)

Sets user for the version

Parameters:

user -

getDateAsString

public java.lang.String getDateAsString()

Returns date represented by string.

getVersionAsString

public java.lang.String getVersionAsString()

Returns string representation about version number.

Returns:

string which represents version number.

getNumberAsString

@Deprecated
public java.lang.String getNumberAsString()

Deprecated.

Returns string representation about version number. Deprecated method, use getVersionAsString() instead.

Returns:

string which represents version number.

getVersion

public java.lang.Object getVersion()

Returns version object of project

setVersion

public void setVersion(java.lang.Object version)

Sets version object

Parameters:

user -

getTags

public java.util.List<java.lang.String> getTags()

Returns all tags.

getProjectDescriptor

public ProjectDescriptor getProjectDescriptor()

Returns:

projectDescriptor Project Descriptor

setProjectDescriptor

public void setProjectDescriptor(ProjectDescriptor projectDescriptor)

Set project descriptor.

Parameters:

projectDescriptor - project Descriptor