AuthzStatus

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD

DETAIL: ENUM CONSTANTS | FIELD | METHOD

com.google.enterprise.adaptor
Enum AuthzStatus

java.lang.Object
  java.lang.Enum<AuthzStatus>
      com.google.enterprise.adaptor.AuthzStatus

All Implemented Interfaces:: Serializable, Comparable<AuthzStatus>

public enum AuthzStatus
extends Enum<AuthzStatus>
extends Enum<AuthzStatus>

Authorization status codes.

Enum Constant Summary
`DENY` The authorization is explicitly forbidden.
`INDETERMINATE` Permission is neither granted nor forbidden.
`PERMIT` The authorization is granted.

Method Summary
`String`	`getDescription()` Get a short description of the status.
`static AuthzStatus`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static AuthzStatus[]`	`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

PERMIT

public static final AuthzStatus PERMIT

The authorization is granted.

DENY

public static final AuthzStatus DENY

The authorization is explicitly forbidden.

INDETERMINATE

public static final AuthzStatus INDETERMINATE

Permission is neither granted nor forbidden. If a consumer recieves this code it may decide to try other means to get an explicit decision (i.e., PERMIT or DENY.

Method Detail

values

public static AuthzStatus[] 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 (AuthzStatus c : AuthzStatus.values())
    System.out.println(c);

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

valueOf

public static AuthzStatus 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

getDescription

public String getDescription()

Get a short description of the status.