|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.microsoft.tfs.core.checkinpolicies.PolicyAnnotation
public class PolicyAnnotation
A PolicyAnnotation contains one or more PolicyDefinitions,
and can be serialized to and from a TFS annotation on a single team project.
| Field Summary | |
|---|---|
static java.lang.String |
CHECKIN_POLICY_ANNOTATION_NAME
The annotation name used in TFS. |
static int |
SUPPORTED_VERSION
The single data version we read and write. |
| Constructor Summary | |
|---|---|
PolicyAnnotation(PolicyDefinition[] definitions)
Creates an annotation that holds the given definitions. |
|
| Method Summary | |
|---|---|
static PolicyAnnotation |
fromAnnotation(java.lang.String annotationValue)
Reads a PolicyAnnotation from the given annotation value string. |
PolicyDefinition[] |
getDefinitions()
|
java.lang.String |
toAnnotationValue()
Encodes this PolicyAnnotation into a string suitable for storage
in a TFS annotation value. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final java.lang.String CHECKIN_POLICY_ANNOTATION_NAME
"TeampriseCheckinPolicies"public static final int SUPPORTED_VERSION
1| Constructor Detail |
|---|
public PolicyAnnotation(PolicyDefinition[] definitions)
definitions - an array of at least one definition (must not be null
)| Method Detail |
|---|
public static PolicyAnnotation fromAnnotation(java.lang.String annotationValue)
throws PolicySerializationException
PolicyAnnotation from the given annotation value string.
annotationValue - the annotation value string to read from (must not be
null)
PolicyAnnotation containing all
PolicyDefinitions loaded from the annotation.
PolicySerializationException - if an error occurred reading the annotation value.public java.lang.String toAnnotationValue()
PolicyAnnotation into a string suitable for storage
in a TFS annotation value.
PolicyAnnotation's
data.public PolicyDefinition[] getDefinitions()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||