Package org.spongepowered.configurate

Interface ConfigurationVisitor.Stateless<E extends Exception>

All Superinterfaces:

ConfigurationVisitor<Void,Void,E>

Enclosing interface:

ConfigurationVisitor<S,T,E extends Exception>

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public static interface ConfigurationVisitor.Stateless<E extends Exception>
extends ConfigurationVisitor<Void,Void,E>

Stateless specialization of visitors, where both the state and terminal type are Void.

Since:

4.0.0

Nested Class Summary

Nested classes/interfaces inherited from interface org.spongepowered.configurate.ConfigurationVisitor

ConfigurationVisitor.Safe<S,T>, ConfigurationVisitor.Stateless<E extends Exception>

Method Summary

Modifier and Type	Method	Description
default void	beginVisit(ConfigurationNode node)	Called at the beginning of the visit with a state object created.
default void	beginVisit(ConfigurationNode node, Void state)	Called at the beginning of the visit with a state object created.
default void	endVisit()	Called after every node has been visited, to allow for cleanup and validation.
default Void	endVisit(Void state)	Called after every node has been visited, to allow for cleanup and validation.
default void	enterListNode(ConfigurationNode node)	Called after ConfigurationVisitor.enterNode(ConfigurationNode, Object) for list nodes.
default void	enterListNode(ConfigurationNode node, Void state)	Called after ConfigurationVisitor.enterNode(ConfigurationNode, Object) for list nodes.
default void	enterMappingNode(ConfigurationNode node)	Called after ConfigurationVisitor.enterNode(ConfigurationNode, Object) for mapping nodes.
default void	enterMappingNode(ConfigurationNode node, Void state)	Called after ConfigurationVisitor.enterNode(ConfigurationNode, Object) for mapping nodes.
void	enterNode(ConfigurationNode node)	Called once per node, for every node.
default void	enterNode(ConfigurationNode node, Void state)	Called once per node, for every node.
default void	enterScalarNode(ConfigurationNode node)	Called after ConfigurationVisitor.enterNode(ConfigurationNode, Object) for scalar nodes.
default void	enterScalarNode(ConfigurationNode node, Void state)	Called after ConfigurationVisitor.enterNode(ConfigurationNode, Object) for scalar nodes.
default void	exitListNode(ConfigurationNode node)	Called for a list node after the node and any of its children have been visited.
default void	exitListNode(ConfigurationNode node, Void state)	Called for a list node after the node and any of its children have been visited.
default void	exitMappingNode(ConfigurationNode node)	Called for a mapping node after the node and any of its children have been visited.
default void	exitMappingNode(ConfigurationNode node, Void state)	Called for a list node after the node and any of its children have been visited.
default Void	newState()	Called to provide a state object if a visit is initiated without one already existing.

Method Detail

newState

default Void newState()

Description copied from interface: ConfigurationVisitor

Called to provide a state object if a visit is initiated without one already existing.

Specified by:

newState in interface ConfigurationVisitor<Void,Void,E extends Exception>

Returns:

a new state object to be passed through the rest of this visit

beginVisit

default void beginVisit(ConfigurationNode node,
                        Void state)
                 throws E extends Exception

Description copied from interface: ConfigurationVisitor

Called at the beginning of the visit with a state object created.

Specified by:

beginVisit in interface ConfigurationVisitor<Void,Void,E extends Exception>

Parameters:

node - the root node

state - the state

Throws:

E - when thrown by implementation

E extends Exception

beginVisit

default void beginVisit(ConfigurationNode node)
                 throws E extends Exception

Called at the beginning of the visit with a state object created.

Parameters:

node - the root node

Throws:

E - as required by implementation

E extends Exception

Since:

4.0.0

enterNode

default void enterNode(ConfigurationNode node,
                       Void state)
                throws E extends Exception

Description copied from interface: ConfigurationVisitor

Called once per node, for every node.

Specified by:

enterNode in interface ConfigurationVisitor<Void,Void,E extends Exception>

Parameters:

node - the current node

state - provided state

Throws:

E - when thrown by implementation

E extends Exception

enterNode

void enterNode(ConfigurationNode node)
        throws E extends Exception

Called once per node, for every node.

Parameters:

node - the current node

Throws:

E - as required by implementation

E extends Exception

Since:

4.0.0

enterMappingNode

default void enterMappingNode(ConfigurationNode node,
                              Void state)
                       throws E extends Exception

Description copied from interface: ConfigurationVisitor

Called after ConfigurationVisitor.enterNode(ConfigurationNode, Object) for mapping nodes.

Specified by:

enterMappingNode in interface ConfigurationVisitor<Void,Void,E extends Exception>

Parameters:

node - current node

state - provided state

Throws:

E - when thrown by implementation

E extends Exception

enterMappingNode

default void enterMappingNode(ConfigurationNode node)
                       throws E extends Exception

Called after ConfigurationVisitor.enterNode(ConfigurationNode, Object) for mapping nodes.

Parameters:

node - current node

Throws:

E - when thrown by implementation

E extends Exception

Since:

4.0.0

enterListNode

default void enterListNode(ConfigurationNode node,
                           Void state)
                    throws E extends Exception

Description copied from interface: ConfigurationVisitor

Called after ConfigurationVisitor.enterNode(ConfigurationNode, Object) for list nodes.

Specified by:

enterListNode in interface ConfigurationVisitor<Void,Void,E extends Exception>

Parameters:

node - current node

state - provided state

Throws:

E - when thrown by implementation

E extends Exception

enterListNode

default void enterListNode(ConfigurationNode node)
                    throws E extends Exception

Called after ConfigurationVisitor.enterNode(ConfigurationNode, Object) for list nodes.

Parameters:

node - current node

Throws:

E - when thrown by implementation

E extends Exception

Since:

4.0.0

enterScalarNode

default void enterScalarNode(ConfigurationNode node,
                             Void state)
                      throws E extends Exception

Description copied from interface: ConfigurationVisitor

Called after ConfigurationVisitor.enterNode(ConfigurationNode, Object) for scalar nodes.

Specified by:

enterScalarNode in interface ConfigurationVisitor<Void,Void,E extends Exception>

Parameters:

node - current node

state - provided state

Throws:

E - when thrown by implementation

E extends Exception

enterScalarNode

default void enterScalarNode(ConfigurationNode node)
                      throws E extends Exception

Called after ConfigurationVisitor.enterNode(ConfigurationNode, Object) for scalar nodes.

Parameters:

node - current node

Throws:

E - when thrown by implementation

E extends Exception

Since:

4.0.0

exitMappingNode

default void exitMappingNode(ConfigurationNode node,
                             Void state)
                      throws E extends Exception

Description copied from interface: ConfigurationVisitor

Called for a list node after the node and any of its children have been visited.

Specified by:

exitMappingNode in interface ConfigurationVisitor<Void,Void,E extends Exception>

Parameters:

node - the node that has been visited

state - provided state

Throws:

E - when thrown by implementation

E extends Exception

exitMappingNode

default void exitMappingNode(ConfigurationNode node)
                      throws E extends Exception

Called for a mapping node after the node and any of its children have been visited.

Parameters:

node - the node that has been visited

Throws:

E - when thrown by implementation

E extends Exception

Since:

4.0.0

exitListNode

default void exitListNode(ConfigurationNode node,
                          Void state)
                   throws E extends Exception

Description copied from interface: ConfigurationVisitor

Called for a list node after the node and any of its children have been visited.

Specified by:

exitListNode in interface ConfigurationVisitor<Void,Void,E extends Exception>

Parameters:

node - the node that has been visited

state - provided state

Throws:

E - when thrown by implementation

E extends Exception

exitListNode

default void exitListNode(ConfigurationNode node)
                   throws E extends Exception

Called for a list node after the node and any of its children have been visited.

Parameters:

node - the node that has been visited

Throws:

E - when thrown by implementation

E extends Exception

Since:

4.0.0

endVisit

default Void endVisit(Void state)
               throws E extends Exception

Description copied from interface: ConfigurationVisitor

Called after every node has been visited, to allow for cleanup and validation.

Specified by:

endVisit in interface ConfigurationVisitor<Void,Void,E extends Exception>

Parameters:

state - provided state

Returns:

a terminal value

Throws:

E - when thrown by implementation

E extends Exception

endVisit

default void endVisit()
               throws E extends Exception

Called after every node has been visited, to allow for cleanup and validation.

Throws:

E - when thrown by implementation

E extends Exception

Since:

4.0.0