dk.rode.thesis.proxy
Enum ProxiedPolicy

java.lang.Object
  java.lang.Enum<ProxiedPolicy>
      dk.rode.thesis.proxy.ProxiedPolicy

All Implemented Interfaces:

StringablePolicy<Sequence<?>>, Serializable, Comparable<ProxiedPolicy>

public enum ProxiedPolicy
extends Enum<ProxiedPolicy>
implements StringablePolicy<Sequence<?>>

Additional policies for formatting proxied sequences into char sequences (not part of the core Proxy implementation).

The policies handle both specific proxy classes based on a decorated sub-class, or anonymous sequence proxies created via a SequenceProxyFactory.

Implementation notes:
This is NOT part of the core Proxy functionality, merely to provide better log descriptions!

See implementation notes for the ObjectPolicy enumeration.

Author:

Gunni Rode / rode.dk

See Also:

SequencePolicy, DecoratedPolicy

Nested Class Summary

Nested classes/interfaces inherited from interface dk.rode.thesis.strategy.StringablePolicy

StringablePolicy.NameIdiom, StringablePolicy.Type

Enum Constant Summary

HIDDEN
Policy used to format string representations of proxies that hides the nested structure "from the sequence on".

VISIBLE
Policy used to format string representations of proxies that indicates the nested structure.

Method Summary

StringablePolicy.Type	type() Returns the type of this policy.
static ProxiedPolicy	valueOf(String name) Returns the enum constant of this type with the specified name.
static ProxiedPolicy[]	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

Methods inherited from interface dk.rode.thesis.strategy.StringablePolicy

toString

Enum Constant Detail

HIDDEN

public static final ProxiedPolicy HIDDEN

Policy used to format string representations of proxies that hides the nested structure "from the sequence on".

VISIBLE

public static final ProxiedPolicy VISIBLE

Policy used to format string representations of proxies that indicates the nested structure.

Both specific proxy classed created based on a decorated sequence and proxies based on the java.lang.reflect.Proxy class are respected.

Notice that a given sequence will be listed with all proxies registered to it even if the sequence is accessed outside the scope of the proxy for the current context.

Proxies using HIDDEN as their default policy are respected.

Method Detail

type

public StringablePolicy.Type type()

Description copied from interface: StringablePolicy

Returns the type of this policy.

The stringable context can use the type to decide how to use the textual representation of this policy in conjunction with additional text.

Specified by:

type in interface StringablePolicy<Sequence<?>>

Returns:

StringablePolicy.Type.APPENDABLE.

valueOf

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

values

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

Returns:

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