Modifier and Type	Class and Description
private static class	DocumentOrderingWrapper.CircularDependencyException
private static class	DocumentOrderingWrapper.DocumentOrderingComparator

Field Summary

Modifier and Type	Field and Description
private static final String	AFTER Constant for the `after` element.
private String[]	afterIds The wrapped Document's before IDs.
private static final String	BEFORE Constant for the `before` element.
private String[]	beforeIds The wrapped Document's before IDs.
private static Comparator<DocumentOrderingWrapper>	COMPARATOR `Comparator` implementation to aid in sorting `faces-config` documents.
private static final int	DO_NOT_SWAP Return code indicating that no swap needs to occur for the elements being compared.
private DocumentInfo	documentInfo The wrapped Document.
private String	id The wrapped Document's ID.
private static final Logger	LOGGER Logger for this class.
private static final int	MAX_SORT_PASSED This is the limit on the number of attempts made to sort the documents.
private static final String	NAME Constant for the `name` element.
private static final String	ORDERING Constant for the `ordering` element.
private static final String	OTHERS Constant for the `others` element.
private static final String	OTHERS_KEY Others keyword for sorting.
private static final int	SWAP Return code indicating that element `n` is to be swapped with `n + 1`

Constructor Summary

Access	Constructor and Description
public	DocumentOrderingWrapper(DocumentInfo document) Constructs a new `DocumentOrderingWrapper` for the specified `Document.`

Method Summary

Modifier and Type	Method and Description
private void	checkDuplicates(String[] source, String[] searchTarget) Ensure the IDs in `source` aren't present in `searchTarget`.
public static <K, V extends Comparable<? super V>> Map<K, V>	descendingByValue(Map<K, V> map)
public static boolean	done(DocumentOrderingWrapper[] documents, LinkedList<String> ids)
private static void	enhanceOrderingData(DocumentOrderingWrapper[] wrappers) Update before/after knowledge of all nodes in the array.
private Set<String>	extractIds(Node n, String nodeName) Extract and return a `Set` of IDs contained within the provided `Node`.
public String[]	Returns: this `Document`'s after IDs, if any getAfterIds()
public String[]	Returns: this `Document's before IDs, if any` `getBeforeIds()`
public DocumentInfo	Returns: the wrapped `Document` getDocument()
public static HashMap<String, DocumentOrderingWrapper>	getDocumentHashMap(DocumentOrderingWrapper[] documents)
public String	Returns: this `Document`'s ID, if any getDocumentId()
private String	getDocumentName(Element documentElement)
public static LinkedList<String>	getIds(DocumentOrderingWrapper[] documents)
private String	getNodeText(Node node) Return the textual content, if any, of the provided `Node`.
private void	init() Performs the initialization necessary to allow sorting of `faces-config` documents.
public static int	innerSort(DocumentOrderingWrapper[] documents)
public boolean	Returns: `true` if this document is after the specified `id`, otherwise `false` isAfter(String id)
public boolean	Returns: `true` if any after IDs are present, otherwise, `false` isAfterOrdered()
public boolean	Returns: `true` if this document is after others, otherwise `false` isAfterOthers()
public boolean	Returns: `true` if this document is before the specified `id`, otherwise `false` isBefore(String id)
public boolean	Returns: `true` if any before IDs are present, otherwise `false` isBeforeOrdered()
public boolean	Returns: `true` if this document is before others, otherwise `false` isBeforeOthers()
public boolean	Returns: `true` if this document has any before or after IDs, otherwise `false` isOrdered()
public static void	preSort(DocumentOrderingWrapper[] documents)
private static boolean	Returns: true if `ids` contains `id` search(String[] an array of IDs ids, String the ID to search for id) Simple helper method around `Arrays.binarySearch()`.
public static DocumentOrderingWrapper[]	Returns: an array of DocumentOrderingWrappers that may be smaller than the input array of wrappers. sort(DocumentOrderingWrapper[] Documents to sort documents, List<String> the absolute order as specified in the /WEB-INF/faces-config.xml absoluteOrder) Sort the provided array of `Document`s per the order specified in the List represented by absoluteOrder.
public static void	sort(DocumentOrderingWrapper[] documents) Sort the provided array of `Document`s per the requirements of the 2.0 specification.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

AFTER	back to summary
private static final String AFTER Constant for the `after` element.

afterIds	back to summary
private String[] afterIds The wrapped Document's before IDs.

BEFORE	back to summary
private static final String BEFORE Constant for the `before` element.

beforeIds	back to summary
private String[] beforeIds The wrapped Document's before IDs.

COMPARATOR	back to summary
private static Comparator<DocumentOrderingWrapper> COMPARATOR `Comparator` implementation to aid in sorting `faces-config` documents.

DO_NOT_SWAP	back to summary
private static final int DO_NOT_SWAP Return code indicating that no swap needs to occur for the elements being compared.

documentInfo	back to summary
private DocumentInfo documentInfo The wrapped Document.

id	back to summary
private String id The wrapped Document's ID.

LOGGER	back to summary
private static final Logger LOGGER Logger for this class.

MAX_SORT_PASSED	back to summary
private static final int MAX_SORT_PASSED This is the limit on the number of attempts made to sort the documents. Any attempt to exceed this limit will result in an Exception being thrown.

NAME	back to summary
private static final String NAME Constant for the `name` element.

ORDERING	back to summary
private static final String ORDERING Constant for the `ordering` element.

OTHERS	back to summary
private static final String OTHERS Constant for the `others` element.

OTHERS_KEY	back to summary
private static final String OTHERS_KEY Others keyword for sorting.

SWAP	back to summary
private static final int SWAP Return code indicating that element `n` is to be swapped with `n + 1`

Constructor Detail

DocumentOrderingWrapper	back to summary
public DocumentOrderingWrapper(DocumentInfo document) Constructs a new `DocumentOrderingWrapper` for the specified `Document.`

Method Detail

checkDuplicates	back to summary
private void checkDuplicates(String[] source, String[] searchTarget) Ensure the IDs in `source` aren't present in `searchTarget`.

descendingByValue	back to summary
public static <K, V extends Comparable<? super V>> Map<K, V> descendingByValue(Map<K, V> map)

done	back to summary
public static boolean done(DocumentOrderingWrapper[] documents, LinkedList<String> ids)

enhanceOrderingData	back to summary
private static void enhanceOrderingData(DocumentOrderingWrapper[] wrappers) throws CircularDependencyException Update before/after knowledge of all nodes in the array. Consider the case of A after B, B after C, C after D, and D with no ordering characteristics. When the code below executes, the before/after of specific nodes will be updated so that in the case of the example above we'd have: A -> after B B -> before A, after C C -> before B, A after D D -> before C, B, A So when an attempt is made to sort [A, B, C, D] the end result is [D, C, B, A] No extra enhancement of after ID information is necessary outside of the single node information due to the way the algorithm processes the array. This method also performs cyclic detection. If, after updating the before/after information, the before/after information contains a reference to the document ID we're currently processing, throw an exception.

enhanceOrderingData

back to summary

private static void enhanceOrderingData(DocumentOrderingWrapper[] wrappers) throws CircularDependencyException

Update before/after knowledge of all nodes in the array. Consider the case of A after B, B after C, C after D, and D with no ordering characteristics. When the code below executes, the before/after of specific nodes will be updated so that in the case of the example above we'd have: A -> after B B -> before A, after C C -> before B, A after D D -> before C, B, A So when an attempt is made to sort [A, B, C, D] the end result is [D, C, B, A] No extra enhancement of after ID information is necessary outside of the single node information due to the way the algorithm processes the array. This method also performs cyclic detection. If, after updating the before/after information, the before/after information contains a reference to the document ID we're currently processing, throw an exception.

extractIds	back to summary
private Set<String> extractIds(Node n, String nodeName) Extract and return a `Set` of IDs contained within the provided `Node`.

getAfterIds	back to summary
public String[] getAfterIds() Returns:String[] this `Document`'s after IDs, if any

getBeforeIds	back to summary
public String[] getBeforeIds() Returns:String[] this `Document's before IDs, if any`

getDocument	back to summary
public DocumentInfo getDocument() Returns:DocumentInfo the wrapped `Document`

getDocumentHashMap	back to summary
public static HashMap<String, DocumentOrderingWrapper> getDocumentHashMap(DocumentOrderingWrapper[] documents)

getDocumentId	back to summary
public String getDocumentId() Returns:String this `Document`'s ID, if any

getDocumentName	back to summary
private String getDocumentName(Element documentElement)

getIds	back to summary
public static LinkedList<String> getIds(DocumentOrderingWrapper[] documents)

getNodeText	back to summary
private String getNodeText(Node node) Return the textual content, if any, of the provided `Node`.

init	back to summary
private void init() Performs the initialization necessary to allow sorting of `faces-config` documents.

innerSort	back to summary
public static int innerSort(DocumentOrderingWrapper[] documents)

isAfter	back to summary
public boolean isAfter(String id) Returns:boolean `true` if this document is after the specified `id`, otherwise `false`

isAfterOrdered	back to summary
public boolean isAfterOrdered() Returns:boolean `true` if any after IDs are present, otherwise, `false`

isAfterOthers	back to summary
public boolean isAfterOthers() Returns:boolean `true` if this document is after others, otherwise `false`

isBefore	back to summary
public boolean isBefore(String id) Returns:boolean `true` if this document is before the specified `id`, otherwise `false`

isBeforeOrdered	back to summary
public boolean isBeforeOrdered() Returns:boolean `true` if any before IDs are present, otherwise `false`

isBeforeOthers	back to summary
public boolean isBeforeOthers() Returns:boolean `true` if this document is before others, otherwise `false`

isOrdered	back to summary
public boolean isOrdered() Returns:boolean `true` if this document has any before or after IDs, otherwise `false`

preSort	back to summary
public static void preSort(DocumentOrderingWrapper[] documents)

search back to summary

search	back to summary
private static boolean search(String[] ids, String id) Simple helper method around `Arrays.binarySearch()`. Parameters ids:String[] an array of IDs id:String the ID to search for Returns:boolean true if `ids` contains `id`

private static boolean search(String[] ids, String id)

Simple helper method around Arrays.binarySearch().

Parameters

ids:String[]: an array of IDs
id:String: the ID to search for

Returns:boolean

true if ids contains id

sort back to summary

sort	back to summary
public static DocumentOrderingWrapper[] sort(DocumentOrderingWrapper[] documents, List<String> absoluteOrder) Sort the provided array of `Document`s per the order specified in the List represented by absoluteOrder. Parameters documents:DocumentOrderingWrapper[] Documents to sort absoluteOrder:List<String> the absolute order as specified in the /WEB-INF/faces-config.xml Returns:DocumentOrderingWrapper[] an array of DocumentOrderingWrappers that may be smaller than the input array of wrappers.

public static DocumentOrderingWrapper[] sort(DocumentOrderingWrapper[] documents, List<String> absoluteOrder)

Sort the provided array of Documents per the order specified in the List represented by absoluteOrder.

Parameters

documents:DocumentOrderingWrapper[]: Documents to sort
absoluteOrder:List<String>: the absolute order as specified in the /WEB-INF/faces-config.xml

Returns:DocumentOrderingWrapper[]

an array of DocumentOrderingWrappers that may be smaller than the input array of wrappers.

sort	back to summary
public static void sort(DocumentOrderingWrapper[] documents) Sort the provided array of `Document`s per the requirements of the 2.0 specification. Note, that this method only provides partial ordering and not absolute ordering.

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

com.sun.faces.config.manager.documents back to summary

private final Class DocumentOrderingWrapper.CircularDependencyException

Class Inheritance

extends Exception

java.lang.Object
java.lang.Throwable
java.lang.Exception
com.sun.faces.config.manager.documents.DocumentOrderingWrapper.CircularDependencyException

Annotations

@SuppressWarnings:serial

Constructor Summary

Access	Constructor and Description
public	CircularDependencyException()

Constructor Detail

CircularDependencyException	back to summary
public CircularDependencyException()

com.sun.faces.config.manager.documents back to summary

private final Class DocumentOrderingWrapper.DocumentOrderingComparator

Class Inheritance

extends Object
implements Comparator<DocumentOrderingWrapper>

java.lang.Object
com.sun.faces.config.manager.documents.DocumentOrderingWrapper.DocumentOrderingComparator

All Implemented Interfaces

java.util.Comparator

Constructor Summary

Access	Constructor and Description
private	DocumentOrderingComparator()

Method Summary

Modifier and Type	Method and Description
public int	compare(DocumentOrderingWrapper the first object to be compared. wrapper1, DocumentOrderingWrapper the second object to be compared. wrapper2) Implements java.util.Comparator.compare. Compares its two arguments for order.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

DocumentOrderingComparator	back to summary
private DocumentOrderingComparator()

Method Detail

compare back to summary

public int compare(DocumentOrderingWrapper wrapper1, DocumentOrderingWrapper wrapper2)

Implements java.util.Comparator.compare.

Doc from java.util.Comparator.compare.

Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

The implementor must ensure that signum(compare(x, y)) == -signum(compare(y, x)) for all x and y. (This implies that compare(x, y) must throw an exception if and only if compare(y, x) throws an exception.)

The implementor must also ensure that the relation is transitive: ((compare(x, y)>0) && (compare(y, z)>0)) implies compare(x, z)>0.

Finally, the implementor must ensure that compare(x, y)==0 implies that signum(compare(x, z))==signum(compare(y, z)) for all z.

Parameters

wrapper1:DocumentOrderingWrapper: the first object to be compared.
wrapper2:DocumentOrderingWrapper: the second object to be compared.

Returns:int

a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

Annotations

@Override

public Class DocumentOrderingWrapper

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class DocumentOrderingWrapper.CircularDependencyException

Constructor Summary

Constructor Detail

private final Class DocumentOrderingWrapper.DocumentOrderingComparator

Constructor Summary

Method Summary

Constructor Detail

Method Detail