com.github.sardine

Enum DavPrincipal.PrincipalType

java.lang.Object

java.lang.Enum<DavPrincipal.PrincipalType>

com.github.sardine.DavPrincipal.PrincipalType

All Implemented Interfaces:

Serializable, Comparable<DavPrincipal.PrincipalType>

Enclosing class:

DavPrincipal

public static enum DavPrincipal.PrincipalType
extends Enum<DavPrincipal.PrincipalType>

A "principal" is a distinct human or computational actor that initiates access to network resources. In this protocol, a principal is an HTTP resource that represents such an actor.

The DAV:principal element identifies the principal to which this ACE applies.

<!ELEMENT principal (href | all | authenticated | unauthenticated | property | self)>

The current user matches DAV:href only if that user is authenticated as being (or being a member of) the principal identified by the URL contained by that DAV:href.

Either a href or one of all,authenticated,unauthenticated,property,self.

DAV:property not supported.

Enum Constant Summary

Enum Constants

Enum Constant and Description
HREF Principal is a String reference to an existing principal (url)
KEY Principal is String as one of the special values: all, authenticated, unauthenticated, self
PROPERTY Principal is QNAME referencing a property (eg: DAV::owner, custom:someGroupId) that itself contains a href to an existing principal

Method Summary

Modifier and Type	Method and Description
static DavPrincipal.PrincipalType	valueOf(String name) Returns the enum constant of this type with the specified name.
static DavPrincipal.PrincipalType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

HREF

public static final DavPrincipal.PrincipalType HREF

Principal is a String reference to an existing principal (url)

KEY

public static final DavPrincipal.PrincipalType KEY

Principal is String as one of the special values: all, authenticated, unauthenticated, self

PROPERTY

public static final DavPrincipal.PrincipalType PROPERTY

Principal is QNAME referencing a property (eg: DAV::owner, custom:someGroupId) that itself contains a href to an existing principal

Method Detail

values

public static DavPrincipal.PrincipalType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DavPrincipal.PrincipalType c : DavPrincipal.PrincipalType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DavPrincipal.PrincipalType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null