Index
All Classes and Interfaces|All Packages|Serialized Form
A
- activateSession() - Method in interface com.madzera.happytree.TreeTransaction
-
Activates the current session.
- activateSession(String) - Method in interface com.madzera.happytree.TreeTransaction
-
Activates a session by the specified
identifier. - addAttribute(String, Object) - Method in class com.madzera.happytree.core.TreePipeline
- addChild(Element) - Method in interface com.madzera.happytree.Element
-
Adds a new child element into the current element.
- addChildren(Collection) - Method in interface com.madzera.happytree.Element
-
Adds a list of child elements to be concatenated to the current children list.
- apply(Consumer) - Method in interface com.madzera.happytree.Element
-
Applies a function to be performed on this element and all its children recursively within the tree structure.
- apply(Consumer) - Method in interface com.madzera.happytree.TreeManager
-
Applies a function to be performed on all elements within the entire tree structure.
- apply(Consumer, Predicate) - Method in interface com.madzera.happytree.Element
-
Applies a function to be performed within this element that satisfies the specified condition.
- apply(Consumer, Predicate) - Method in interface com.madzera.happytree.TreeManager
-
Applies a function to be performed on elements that satisfy a specific condition within the entire tree structure.
- ATPFactory - Class in com.madzera.happytree.core.atp
- ATPFactory() - Constructor for class com.madzera.happytree.core.atp.ATPFactory
- ATPFactory.ATPPhaseInstance - Enum in com.madzera.happytree.core.atp
- ATPPhase<T> - Class in com.madzera.happytree.core
- ATPPhase() - Constructor for class com.madzera.happytree.core.ATPPhase
- ATPUnitTestHelper - Class in com.madzera.happytree.core.atp
-
The class
ATPUnitTestHelperis a helper class to provide access to internal methods of the ATP package for JUnit tests purposes. - attachedTo() - Method in interface com.madzera.happytree.Element
-
Returns the
TreeSessioninstance to which this element belongs.
B
- BINDING - Enum constant in enum com.madzera.happytree.core.atp.ATPFactory.ATPPhaseInstance
C
- cloneSession(TreeSession, String) - Method in interface com.madzera.happytree.TreeTransaction
-
Replicates the tree session defined by
fromsession instance for the session defined bytoidentifier. - cloneSession(String, String) - Method in interface com.madzera.happytree.TreeTransaction
-
Replicates the tree session defined by the
fromidentifier to the session defined by thetoidentifier. - com.madzera.happytree - package com.madzera.happytree
- com.madzera.happytree.annotation - package com.madzera.happytree.annotation
- com.madzera.happytree.core - package com.madzera.happytree.core
- com.madzera.happytree.core.atp - package com.madzera.happytree.core.atp
- com.madzera.happytree.exception - package com.madzera.happytree.exception
- containsElement(Element) - Method in interface com.madzera.happytree.TreeManager
-
Verifies that the current tree session has the specified
element. - containsElement(Element, Element) - Method in interface com.madzera.happytree.TreeManager
-
Verifies whether the
parentelement contains inside of it thedescendantelement in this current session. - containsElement(Object) - Method in interface com.madzera.happytree.TreeManager
-
Verifies that the current tree session has the specified element by the given
@Id. - containsElement(Object, Object) - Method in interface com.madzera.happytree.TreeManager
-
Verifies whether the
parentelement contains inside of it thedescendantelement in this current session. - copy(Element, Element) - Method in interface com.madzera.happytree.TreeManager
-
Copies the respective
fromelement into thetoelement in another tree session. - createElement(Object, Object, T) - Method in interface com.madzera.happytree.TreeManager
-
Creates an element with the
id,parentand the wrapped object node. - createTreeManager() - Static method in class com.madzera.happytree.core.HappyTree
-
Returns an instance of
TreeManager, representing the entry point of the HappyTree API. - currentSession() - Method in interface com.madzera.happytree.TreeTransaction
-
Returns the current session of the transaction.
- cut(Element, Element) - Method in interface com.madzera.happytree.TreeManager
-
Cuts the
fromelement into thetoelement, whether for the same session or not. - cut(Object, Object) - Method in interface com.madzera.happytree.TreeManager
-
Cuts the
fromelement into thetoelement, inside of the same session.
D
- deactivateSession() - Method in interface com.madzera.happytree.TreeTransaction
-
Deactivates the current session.
- deactivateSession(String) - Method in interface com.madzera.happytree.TreeTransaction
-
Deactivates a session by the specified
identifier. - destroyAllSessions() - Method in interface com.madzera.happytree.TreeTransaction
-
Removes all the registered sessions.
- destroySession() - Method in interface com.madzera.happytree.TreeTransaction
-
Removes the current session previously checked out.
- destroySession(String) - Method in interface com.madzera.happytree.TreeTransaction
-
Removes the session with the specified
identifier. - doChain(TreePipeline) - Method in class com.madzera.happytree.core.ATPPhase
E
- Element<T> - Interface in com.madzera.happytree
-
An
Elementrepresents a node within a tree. - executeInternalMethod(String, String) - Static method in class com.madzera.happytree.core.atp.ATPUnitTestHelper
-
This method helps HappyTree API to cover code blocks that is not accessible from outside for JUnit tests purposes.
- executeInternalMethod(String, String) - Static method in class com.madzera.happytree.core.TreeUnitTestHelper
-
This method helps HappyTree API to cover code blocks that is not accessible from outside for JUnit tests purposes.
- EXTRACTION - Enum constant in enum com.madzera.happytree.core.atp.ATPFactory.ATPPhaseInstance
G
- getAttribute(String) - Method in class com.madzera.happytree.core.TreePipeline
- getChildren() - Method in interface com.madzera.happytree.Element
-
Obtains all child elements of the current element.
- getElementById(Object) - Method in interface com.madzera.happytree.Element
-
Searches within the current element for an element according to the
idparameter. - getElementById(Object) - Method in interface com.madzera.happytree.TreeManager
-
Obtains an element by
@Idin the current tree session. - getId() - Method in interface com.madzera.happytree.Element
-
Obtains the element identifier.
- getParent() - Method in interface com.madzera.happytree.Element
-
Obtains the parent identifier of this element.
- getPhaseInstance(ATPFactory.ATPPhaseInstance) - Method in class com.madzera.happytree.core.atp.ATPFactory
- getSessionId() - Method in interface com.madzera.happytree.TreeSession
-
Returns the session identifier name.
- getTransaction() - Method in interface com.madzera.happytree.TreeManager
-
Returns the
TreeTransactioninstance associated with this manager.
H
- HappyTree - Class in com.madzera.happytree.core
-
Helper class that provides the entry point of the HappyTree API.
I
- Id - Annotation Type in com.madzera.happytree.annotation
-
Represents the identifier of a tree node class.
- INITIALIZATION - Enum constant in enum com.madzera.happytree.core.atp.ATPFactory.ATPPhaseInstance
- initializeSession(String, Class) - Method in interface com.madzera.happytree.TreeTransaction
-
Initializes a new empty tree session with the specified identifier.
- initializeSession(String, Collection) - Method in interface com.madzera.happytree.TreeTransaction
-
Initializes a session with a specified identifier and a list of linear objects (with a logical tree structure) to be transformed into an actual tree structure.
- isActive() - Method in interface com.madzera.happytree.TreeSession
-
Verifies whether the session is active.
L
- lifecycle() - Method in interface com.madzera.happytree.Element
-
Returns the current lifecycle state of this element.
N
- next(ATPPhase) - Method in class com.madzera.happytree.core.ATPPhase
P
- Parent - Annotation Type in com.madzera.happytree.annotation
-
Represents a reference to the parent identifier of an object in a tree model.
- persistElement(Element) - Method in interface com.madzera.happytree.TreeManager
-
Persists a new element into the current tree session.
- PRE_VALIDATION - Enum constant in enum com.madzera.happytree.core.atp.ATPFactory.ATPPhaseInstance
R
- removeChild(Element) - Method in interface com.madzera.happytree.Element
-
Removes the specified
childelement from the children list of the current element. - removeChild(Object) - Method in interface com.madzera.happytree.Element
-
Removes the element from the children list of the current element by the
idparameter. - removeChildren(Collection) - Method in interface com.madzera.happytree.Element
-
Removes a subset of elements within this one.
- removeElement(Element) - Method in interface com.madzera.happytree.TreeManager
-
Removes the corresponding element from the tree session and returns the removed element itself.
- removeElement(Object) - Method in interface com.madzera.happytree.TreeManager
-
Removes the element by its
@Id. - root() - Method in interface com.madzera.happytree.TreeManager
-
Returns the root of the tree in this current session.
- run(TreePipeline) - Method in class com.madzera.happytree.core.ATPPhase
S
- search(Predicate) - Method in interface com.madzera.happytree.Element
-
Searches for elements that satisfy a specific condition within this element and its children recursively.
- search(Predicate) - Method in interface com.madzera.happytree.TreeManager
-
Searches for elements that satisfy a specific condition within the entire tree structure.
- sessionCheckout(String) - Method in interface com.madzera.happytree.TreeTransaction
-
Selects a tree session to work with it.
- sessions() - Method in interface com.madzera.happytree.TreeTransaction
-
Returns the list of all registered sessions.
- setId(Object) - Method in interface com.madzera.happytree.Element
-
Sets the element identifier.
- setParent(Object) - Method in interface com.madzera.happytree.Element
-
Sets the parent identifier reference of this element.
T
- toJSON() - Method in interface com.madzera.happytree.Element
-
Converts the whole element structure into a JSON format.
- toPrettyJSON() - Method in interface com.madzera.happytree.Element
-
Converts the whole element structure into a well formatted JSON
String. - toPrettyXML() - Method in interface com.madzera.happytree.Element
-
Converts the whole element structure into a well formatted XML
String. - toXML() - Method in interface com.madzera.happytree.Element
-
Converts the whole element structure into an XML
String. - tree() - Method in interface com.madzera.happytree.TreeSession
-
Returns the entire tree session structure, represented by the root element.
- Tree - Annotation Type in com.madzera.happytree.annotation
-
Declarative annotation to indicate that the object of a class represents a node in a tree structure.
- TreeException - Exception Class in com.madzera.happytree.exception
-
The class
TreeExceptionrepresents a checked exception for the HappyTree API by inheriting theExceptionclass. - TreeException() - Constructor for exception class com.madzera.happytree.exception.TreeException
-
Default constructor for this exception.
- TreeException(String) - Constructor for exception class com.madzera.happytree.exception.TreeException
-
This constructor allows specifying a detail message for the exception when it is thrown.
- TreeException(String, Throwable) - Constructor for exception class com.madzera.happytree.exception.TreeException
-
Creates an exception with the specified
messageandcause. - TreeException(Throwable) - Constructor for exception class com.madzera.happytree.exception.TreeException
-
Creates an exception with the specified
cause. - TreeManager - Interface in com.madzera.happytree
-
Provides ways to handle elements within a tree session.
- TreePipeline - Class in com.madzera.happytree.core
- TreeSession - Interface in com.madzera.happytree
-
Interface responsible for storing element trees.
- TreeTransaction - Interface in com.madzera.happytree
-
Dedicated interface to handle all stored tree sessions.
- TreeUnitTestHelper - Class in com.madzera.happytree.core
-
The class
TreeUnitTestHelperis a helper class to provide access to internal methods of the core package for JUnit tests purposes.
U
- unwrap() - Method in interface com.madzera.happytree.Element
-
Returns a copy of the object node wrapped in this element.
- updateElement(Element) - Method in interface com.madzera.happytree.TreeManager
-
Updates the state of the element to the tree.
V
- valueOf(String) - Static method in enum com.madzera.happytree.core.atp.ATPFactory.ATPPhaseInstance
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.madzera.happytree.core.atp.ATPFactory.ATPPhaseInstance
-
Returns an array containing the constants of this enum type, in the order they are declared.
W
- wrap(T) - Method in interface com.madzera.happytree.Element
-
Encapsulates any object node within the element, as long as this object has the same class type as other objects that were encapsulated within the same tree session.
All Classes and Interfaces|All Packages|Serialized Form