com.google.caja.plugin
Enum UriEffect

java.lang.Object
  extended by java.lang.Enum<UriEffect>
      extended by com.google.caja.plugin.UriEffect
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<UriEffect>

public enum UriEffect
extends java.lang.Enum<UriEffect>

Explains the effect that allowing a URI to load has.

Author:
Mike Samuel
See Also:
UriPolicy

Enum Constant Summary
NEW_DOCUMENT
          Describes a URI that is loaded on user interaction, replacing the current document with a new document, and that is loaded into the origin implied in the URI.
NOT_LOADED
          Describes a URI that is not loaded.
SAME_DOCUMENT
          Describes a URI that is automatically loaded into the current document's origin.
 
Method Summary
static UriEffect valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static UriEffect[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

NOT_LOADED

public static final UriEffect NOT_LOADED
Describes a URI that is not loaded. E.g. <base href>.


SAME_DOCUMENT

public static final UriEffect SAME_DOCUMENT
Describes a URI that is automatically loaded into the current document's origin. E.g. <img src>.


NEW_DOCUMENT

public static final UriEffect NEW_DOCUMENT
Describes a URI that is loaded on user interaction, replacing the current document with a new document, and that is loaded into the origin implied in the URI. This may or may not unload the current document.

Method Detail

values

public static final UriEffect[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(UriEffect c : UriEffect.values())
        System.out.println(c);

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

valueOf

public static UriEffect valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name


Copyright (C) 2008 Google Inc.
Licensed under the Apache License, Version 2.0