net.praqma.clearcase.api

Class Describe

java.lang.Object

net.praqma.clearcase.api.Command<List<String>>

net.praqma.clearcase.api.Describe

public class Describe
extends Command<List<String>>

Author:

cwolfgang

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Describe.Property
static class	Describe.Type

Field Summary

Fields

Modifier and Type	Field and Description
static Describe.Property	activity
static Describe.Property	dependsOn
static Describe.Property	dependsOnClosure
static Describe.Property	initialBaseline
static Describe.Property	memberOfClosure
static Describe.Property	versions

Fields inherited from class net.praqma.clearcase.api.Command

root

Constructor Summary

Constructors

Constructor and Description
Describe(String objectSelector)
Describe(UCMEntity entity)

Method Summary

Modifier and Type	Method and Description
Describe	addModifier(Describe.Property property)
Describe	addModifier(Describe.Property property, boolean commaSeparate)
Describe	addModifier(Describe.Property property, boolean commaSeparate, boolean extended)
Map<String,String[]>	describe() This method will return a grouped result by property for easier access.
Describe	doAcceptEmpty() Allow the execution of the Describe to return null instead of an exception.
List<String>	execute()
String	executeGetFirstLine()
String	executeGetFirstLine(boolean robust)
String	getCommand()
String	getCommandLine()
List<String>	getElements(String string)
Describe	getObjectId()
Map<String,String[]>	getResults(List<String> elements)
Describe	setPath(File path)

Methods inherited from class net.praqma.clearcase.api.Command

hasSpecialCharacters, hasWhiteSpaces, runCommand

Methods inherited from class java.lang.Object

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

Field Detail

activity

public static final Describe.Property activity

memberOfClosure

public static final Describe.Property memberOfClosure

dependsOn

public static final Describe.Property dependsOn

dependsOnClosure

public static final Describe.Property dependsOnClosure

initialBaseline

public static final Describe.Property initialBaseline

versions

public static final Describe.Property versions

Constructor Detail

Describe

public Describe(String objectSelector)

Describe

public Describe(UCMEntity entity)

Method Detail

addModifier

public Describe addModifier(Describe.Property property)

addModifier

public Describe addModifier(Describe.Property property,
                            boolean commaSeparate)

addModifier

public Describe addModifier(Describe.Property property,
                            boolean commaSeparate,
                            boolean extended)

getObjectId

public Describe getObjectId()

setPath

public Describe setPath(File path)

doAcceptEmpty

public Describe doAcceptEmpty()

Allow the execution of the Describe to return null instead of an exception. See FB case 9988.

Returns:

Current Describe command

execute

public List<String> execute()
                     throws CleartoolException

Specified by:

execute in class Command<List<String>>

Throws:

CleartoolException

executeGetFirstLine

public String executeGetFirstLine(boolean robust)
                           throws CleartoolException

Throws:

CleartoolException

executeGetFirstLine

public String executeGetFirstLine()
                           throws CleartoolException

Throws:

CleartoolException

describe

public Map<String,String[]> describe()
                              throws CleartoolException

This method will return a grouped result by property for easier access.

Returns:

Current Describe command

Throws:

CleartoolException - Thrown when ClearCase reports errors

getCommand

public String getCommand()

Specified by:

getCommand in class Command<List<String>>

getCommandLine

public String getCommandLine()

Specified by:

getCommandLine in class Command<List<String>>

getResults

public Map<String,String[]> getResults(List<String> elements)

getElements

public List<String> getElements(String string)