Evaluating Software Design Patterns
— the "Gang of Four" patterns implemented in Java 6

dk.rode.thesis.adapter
Enum AdaptedPolicy

java.lang.Object
  extended by java.lang.Enum<AdaptedPolicy>
      extended by dk.rode.thesis.adapter.AdaptedPolicy
All Implemented Interfaces:
StringablePolicy<Sequence<?>>, Serializable, Comparable<AdaptedPolicy>

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

Additional policies for formatting SequenceAdapter objects into char sequences (not part of the core Adapter implementation).

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

See implementation notes for the ObjectPolicy enumeration.

Author:
Gunni Rode / rode.dk
See Also:
SequencePolicy

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 adapters that hides the nested structure "from the sequence on".
VISIBLE
          Policy used to format string representations of adapters that indicates the nested structure.
 
Method Summary
abstract  CharSequence toString(Sequence<?> sequence)
          Returns a textual representation of the object supplied as object in form of a char sequence.
 StringablePolicy.Type type()
          Returns the type of this policy.
static AdaptedPolicy valueOf(String name)
          Returns the enum constant of this type with the specified name.
static AdaptedPolicy[] 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

HIDDEN

public static final AdaptedPolicy HIDDEN
Policy used to format string representations of adapters that hides the nested structure "from the sequence on".


VISIBLE

public static final AdaptedPolicy VISIBLE
Policy used to format string representations of adapters that indicates the nested structure.

Note, however, that the check for adapted sequences is done using instanceof, which will not discover decorated or proxied sequences!

Adapters using HIDDEN as their default policy are respected.

Method Detail

toString

public abstract CharSequence toString(Sequence<?> sequence)
Returns a textual representation of the object supplied as object in form of a char sequence.

Specified by:
toString in interface StringablePolicy<Sequence<?>>
Parameters:
sequence - The object; cannot be null.
Returns:
The char sequence representation; never null.
See Also:
Stringable.toString(StringablePolicy)

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

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

Gunni Rode / rode.dk

Feel free to use and/or modify the Java 6 source code developed for this thesis AT YOUR OWN RISK, but note that the source code comes WITHOUT ANY — and I do mean WITHOUT ANY — form of warranty WHAT SO EVER!

The original thesis and source code are available at rode.dk/thesis.