Index (com.mackenziehigh:sexpr 1.1 API)

A B C D E F G H I L M N O P S T V W
All Classes and Interfaces|All Packages|Serialized Form

A

after(String, String, Consumer<Sexpr<?>>) - Method in class com.mackenziehigh.sexpr.Schema.Builder: Use this method to define an action that will be executed after matches of a named rule during a specific pass.
After - Annotation Type in com.mackenziehigh.sexpr.annotations: Use this annotation on a method in order to indicate that the method is a schema action to perform after successful matches of a rule with the given name.
append(Sexpr<?>) - Method in class com.mackenziehigh.sexpr.SList.Mutator: This method appends the given value onto the selected node, if the selected node is a symbolic-list.
asAtom() - Method in interface com.mackenziehigh.sexpr.Sexpr: Cast this object to SAtom.
asBoolean() - Method in class com.mackenziehigh.sexpr.SAtom: This method retrieves this value, as a boolean.
asByte() - Method in class com.mackenziehigh.sexpr.SAtom: This method retrieves this value, as a byte.
asChar() - Method in class com.mackenziehigh.sexpr.SAtom: This method retrieves this value, as a char.
asDouble() - Method in class com.mackenziehigh.sexpr.SAtom: This method retrieves this value, as a float.
asFloat() - Method in class com.mackenziehigh.sexpr.SAtom: This method retrieves this value, as a float.
asInt() - Method in class com.mackenziehigh.sexpr.SAtom: This method retrieves this value, as an integer.
asList() - Method in interface com.mackenziehigh.sexpr.Sexpr: Cast this object to SList.
asLong() - Method in class com.mackenziehigh.sexpr.SAtom: This method retrieves this value, as a long.
asMap() - Method in class com.mackenziehigh.sexpr.SList: This method retrieves this value, as a map.
asShort() - Method in class com.mackenziehigh.sexpr.SAtom: This method retrieves this value, as a short.

B

before(String, String, Consumer<Sexpr<?>>) - Method in class com.mackenziehigh.sexpr.Schema.Builder: Use this method to define an action that will be executed before matches of a named rule during a specific pass.
Before - Annotation Type in com.mackenziehigh.sexpr.annotations: Use this annotation on a method in order to indicate that the method is a schema action to perform before successful matches of a rule with the given name.
bfs(Predicate<Sexpr<?>>) - Method in class com.mackenziehigh.sexpr.SAtom: This method performs a breadth-first-search of the tree rooted at this node.
bfs(Predicate<Sexpr<?>>) - Method in interface com.mackenziehigh.sexpr.Sexpr: This method performs a breadth-first-search of the tree rooted at this node.
bfs(Predicate<Sexpr<?>>) - Method in class com.mackenziehigh.sexpr.SList: This method performs a breadth-first-search of the tree rooted at this node.
build() - Method in class com.mackenziehigh.sexpr.Schema.Builder: Use this method to obtain the new schema object.

C

column() - Method in class com.mackenziehigh.sexpr.SourceLocation: This method retrieves the column-number where the symbolic-expression starts.
com.mackenziehigh.sexpr - package com.mackenziehigh.sexpr: Symbolic Expressions.
com.mackenziehigh.sexpr.annotations - package com.mackenziehigh.sexpr.annotations: Symbolic-Expression related Annotation Types.
com.mackenziehigh.sexpr.exceptions - package com.mackenziehigh.sexpr.exceptions: Symbolic-Expression related Exception Types.
com.mackenziehigh.sexpr.internal - package com.mackenziehigh.sexpr.internal: (Private) Implementation Details.
com.mackenziehigh.sexpr.internal.schema - package com.mackenziehigh.sexpr.internal.schema: (Private) Schema Implementation.
com.mackenziehigh.sexpr.util - package com.mackenziehigh.sexpr.util: Utility Classes.
compareTo(Sexpr<?>) - Method in interface com.mackenziehigh.sexpr.Sexpr
condition(String, Predicate<Sexpr<?>>) - Method in class com.mackenziehigh.sexpr.Schema.Builder: Use this method to define a predicate that can be used within a schema.
Condition - Annotation Type in com.mackenziehigh.sexpr.annotations: Use this method to mark a method as the implementation of a user-defined condition that can be referenced by 'require' rules within a symbolic-expression schema.
content() - Method in class com.mackenziehigh.sexpr.SAtom: This method retrieves the series of characters that this atom contains.
content() - Method in class com.mackenziehigh.sexpr.util.OutputFile: This method retrieve the object used to generate the formatted file content.
copyOf(SourceLocation, Iterable<? extends Sexpr<?>>) - Static method in class com.mackenziehigh.sexpr.SList: Factory Method.
copyOf(SourceLocation, Iterator<? extends Sexpr<?>>) - Static method in class com.mackenziehigh.sexpr.SList: Factory Method.
copyOf(SourceLocation, Stream<? extends Sexpr<?>>) - Static method in class com.mackenziehigh.sexpr.SList: Factory Method.
copyOf(Iterable<? extends Sexpr<?>>) - Static method in class com.mackenziehigh.sexpr.SList: Factory Method.
copyOf(Iterator<? extends Sexpr<?>>) - Static method in class com.mackenziehigh.sexpr.SList: Factory Method.
copyOf(Stream<? extends Sexpr<?>>) - Static method in class com.mackenziehigh.sexpr.SList: Factory Method.

D

decrement() - Method in class com.mackenziehigh.sexpr.util.StringPrinter: Use this method in order to make subsequent output less indented.
DEFAULT - Static variable in class com.mackenziehigh.sexpr.SourceLocation
defineAfterAction(String, String, Consumer<Sexpr<?>>) - Method in class com.mackenziehigh.sexpr.internal.schema.InternalSchema
defineBeforeAction(String, String, Consumer<Sexpr<?>>) - Method in class com.mackenziehigh.sexpr.internal.schema.InternalSchema
defineCondition(String, Predicate<Sexpr<?>>) - Method in class com.mackenziehigh.sexpr.internal.schema.InternalSchema: This method defines a condition that can be referenced by a 'require' rule.
definePass(String) - Method in class com.mackenziehigh.sexpr.internal.schema.InternalSchema
defineRoot(String) - Method in class com.mackenziehigh.sexpr.internal.schema.InternalSchema: Use this method to specify the root rule of this schema.
defineViaAnnotations(Object) - Method in class com.mackenziehigh.sexpr.Schema.Builder: Given an object containing properly annotated methods, define the conditions and actions defined therein.
defineViaReflection(Object) - Method in class com.mackenziehigh.sexpr.internal.schema.InternalAnnotator: Given an object containing properly annotated methods, define the conditions and actions defined therein.
dfs(Predicate<Sexpr<?>>) - Method in class com.mackenziehigh.sexpr.SAtom: This method performs a depth-first-search of the tree rooted at this node.
dfs(Predicate<Sexpr<?>>) - Method in interface com.mackenziehigh.sexpr.Sexpr: This method performs a depth-first-search of the tree rooted at this node.
dfs(Predicate<Sexpr<?>>) - Method in class com.mackenziehigh.sexpr.SList: This method performs a depth-first-search of the tree rooted at this node.

E

equals(Object) - Method in class com.mackenziehigh.sexpr.SAtom
equals(Object) - Method in class com.mackenziehigh.sexpr.SList
escape(char[]) - Method in class com.mackenziehigh.sexpr.internal.Escaper: This method creates a string from a char-array, with each special-character replaced with a relevant escape sequence.
escaped() - Method in class com.mackenziehigh.sexpr.SAtom: This method returns the content() with all special characters escaped.
Escaper - Class in com.mackenziehigh.sexpr.internal: Escaper.
execute() - Method in interface com.mackenziehigh.sexpr.Schema.Match: Execute the defined passes and related actions.
expand(String) - Method in class com.mackenziehigh.sexpr.internal.Escaper: This method replaces escape sequences in a string with the equivalent special-characters and then returns the equivalent char-array.

F

file() - Method in class com.mackenziehigh.sexpr.util.OutputFile: This method retrieves the path to where the output file will be written.
first() - Method in class com.mackenziehigh.sexpr.SList: This method retrieves the first element of this list.
first() - Method in class com.mackenziehigh.sexpr.SList.Mutator: This method selects the first element in the currently selected list node().
fromBoolean(boolean) - Static method in class com.mackenziehigh.sexpr.SAtom: Factory Method.
fromBoolean(SourceLocation, boolean) - Static method in class com.mackenziehigh.sexpr.SAtom: Factory Method.
fromByte(byte) - Static method in class com.mackenziehigh.sexpr.SAtom: Factory Method.
fromByte(SourceLocation, byte) - Static method in class com.mackenziehigh.sexpr.SAtom: Factory Method.
fromChar(char) - Static method in class com.mackenziehigh.sexpr.SAtom: Factory Method.
fromChar(SourceLocation, char) - Static method in class com.mackenziehigh.sexpr.SAtom: Factory Method.
fromDouble(double) - Static method in class com.mackenziehigh.sexpr.SAtom: Factory Method.
fromDouble(SourceLocation, double) - Static method in class com.mackenziehigh.sexpr.SAtom: Factory Method.
fromFloat(float) - Static method in class com.mackenziehigh.sexpr.SAtom: Factory Method.
fromFloat(SourceLocation, float) - Static method in class com.mackenziehigh.sexpr.SAtom: Factory Method.
fromInt(int) - Static method in class com.mackenziehigh.sexpr.SAtom: Factory Method.
fromInt(SourceLocation, int) - Static method in class com.mackenziehigh.sexpr.SAtom: Factory Method.
fromLong(long) - Static method in class com.mackenziehigh.sexpr.SAtom: Factory Method.
fromLong(SourceLocation, long) - Static method in class com.mackenziehigh.sexpr.SAtom: Factory Method.
fromMap(SourceLocation, Map<? extends Sexpr<?>, ? extends Sexpr<?>>) - Static method in class com.mackenziehigh.sexpr.SList: This method creates a new two-dimensional list from the given map.
fromMap(SourceLocation, Map<? extends Sexpr<?>, ? extends Sexpr<?>>, Sexpr<?>) - Static method in class com.mackenziehigh.sexpr.SList: This method creates a new two-dimensional list from the given map.
fromShort(short) - Static method in class com.mackenziehigh.sexpr.SAtom: Factory Method.
fromShort(SourceLocation, short) - Static method in class com.mackenziehigh.sexpr.SAtom: Factory Method.
fromString(SourceLocation, String) - Static method in class com.mackenziehigh.sexpr.SAtom: Factory Method.
fromString(String) - Static method in class com.mackenziehigh.sexpr.SAtom: Factory Method.

G

get(int) - Method in class com.mackenziehigh.sexpr.SList
get(int) - Method in class com.mackenziehigh.sexpr.SList.Mutator: This method selects an element in the currently selected list node().
getIndent() - Method in class com.mackenziehigh.sexpr.util.StringPrinter: Use this method in order to retrieve the current indentation level.

H

hashCode() - Method in class com.mackenziehigh.sexpr.SAtom
hashCode() - Method in class com.mackenziehigh.sexpr.SList

I

include(String) - Method in class com.mackenziehigh.sexpr.Schema.Builder
include(String, String) - Method in class com.mackenziehigh.sexpr.Schema.Builder: This method imports the schema rules defined in the given string.
increment() - Method in class com.mackenziehigh.sexpr.util.StringPrinter: Use this method in order to make subsequent output more indented.
input() - Method in interface com.mackenziehigh.sexpr.Schema.Match: Get the symbolic-expression that was the input to match().
instance - Static variable in class com.mackenziehigh.sexpr.internal.Escaper: This is the singleton instance of this class.
InternalAnnotator - Class in com.mackenziehigh.sexpr.internal.schema
InternalAnnotator(Schema.Builder) - Constructor for class com.mackenziehigh.sexpr.internal.schema.InternalAnnotator
InternalSchema - Class in com.mackenziehigh.sexpr.internal.schema: An instance of this class is a pattern that describes a symbolic-expression.
InternalSchema() - Constructor for class com.mackenziehigh.sexpr.internal.schema.InternalSchema: Sole Constructor.
InternalSchemaParser - Class in com.mackenziehigh.sexpr.internal.schema
InternalSchemaParser(InternalSchema) - Constructor for class com.mackenziehigh.sexpr.internal.schema.InternalSchemaParser
InvalidSchemaException - Exception in com.mackenziehigh.sexpr.exceptions: This type of exception indicates a problem within a schema definition.
InvalidSchemaException(String) - Constructor for exception com.mackenziehigh.sexpr.exceptions.InvalidSchemaException
isAtom() - Method in class com.mackenziehigh.sexpr.SAtom: This method determines whether this object is a SAtom.
isAtom() - Method in interface com.mackenziehigh.sexpr.Sexpr: This method determines whether this object is a SAtom.
isAtom() - Method in class com.mackenziehigh.sexpr.SList: This method determines whether this object is a SAtom.
isFailure() - Method in interface com.mackenziehigh.sexpr.Schema.Match: Determine whether this object represents a unsuccessful match.
isList() - Method in class com.mackenziehigh.sexpr.SAtom: This method determines whether this object is a SList.
isList() - Method in interface com.mackenziehigh.sexpr.Sexpr: This method determines whether this object is a SList.
isList() - Method in class com.mackenziehigh.sexpr.SList: This method determines whether this object is a SList.
isSuccess() - Method in interface com.mackenziehigh.sexpr.Schema.Match: Determine whether this object represents a successful match.

L

last() - Method in class com.mackenziehigh.sexpr.SList: This method retrieves the last element of this list.
last() - Method in class com.mackenziehigh.sexpr.SList.Mutator: This method selects the last element in the currently selected list node().
lastSuccess() - Method in interface com.mackenziehigh.sexpr.Schema.Match: Get the last node of the input that was successfully matched, if any, which is useful for locating and reporting errors in the input.
line() - Method in class com.mackenziehigh.sexpr.SourceLocation: This method retrieves the line-number where the symbolic-expression starts.
location() - Method in exception com.mackenziehigh.sexpr.exceptions.ParsingFailedException
location() - Method in class com.mackenziehigh.sexpr.SAtom: This method retrieves an object describing the source from which this object we obtained.
location() - Method in interface com.mackenziehigh.sexpr.Sexpr: This method retrieves an object describing the source from which this object we obtained.
location() - Method in class com.mackenziehigh.sexpr.SList: This method retrieves an object describing the source from which this object we obtained.

M

main(String[]) - Static method in class com.mackenziehigh.sexpr.internal.Parser
match(Sexpr) - Method in class com.mackenziehigh.sexpr.internal.schema.InternalSchema: This method performs a match-attempt.
match(Sexpr<?>) - Method in class com.mackenziehigh.sexpr.Schema: This method determines whether the given symbolic-expression obeys this schema.
message() - Method in class com.mackenziehigh.sexpr.SourceLocation: This method returns a human-readable message based on this location.
mutator() - Method in class com.mackenziehigh.sexpr.SList: This method obtains a mutator that can be used to non-destructively modify the tree rooted at this node.
Mutator(SList) - Constructor for class com.mackenziehigh.sexpr.SList.Mutator: Sole Public Constructor.

N

newBuilder() - Static method in class com.mackenziehigh.sexpr.Schema: Builder Factory.
node() - Method in class com.mackenziehigh.sexpr.SList.Mutator: This method retrieves the currently selected node.

O

of(Sexpr<?>...) - Static method in class com.mackenziehigh.sexpr.SList: Factory Method.
of(SourceLocation, Sexpr<?>...) - Static method in class com.mackenziehigh.sexpr.SList: Factory Method.
output() - Method in class com.mackenziehigh.sexpr.util.StringPrinter: Use this method to retrieve the output string.
OutputFile - Class in com.mackenziehigh.sexpr.util: An instance of this class represents a output text file.
OutputFile(File, int, int) - Constructor for class com.mackenziehigh.sexpr.util.OutputFile: Sole Constructor.

P

parse(InternalSchema, String, String) - Static method in class com.mackenziehigh.sexpr.internal.schema.InternalSchemaParser
parse(String) - Static method in class com.mackenziehigh.sexpr.SList: This method converts the textual representation of a SList to an actual corresponding SList object.
parse(String, String) - Static method in class com.mackenziehigh.sexpr.internal.Parser
parse(String, String) - Static method in class com.mackenziehigh.sexpr.SList: This method converts the textual representation of a SList to an actual corresponding SList object.
parseFile(File) - Static method in class com.mackenziehigh.sexpr.SList: This method converts the textual representation of a text file to an actual corresponding SList object.
Parser - Class in com.mackenziehigh.sexpr.internal: Converts a String to a SList.
Parser() - Constructor for class com.mackenziehigh.sexpr.internal.Parser
parseResource(String) - Static method in class com.mackenziehigh.sexpr.SList: This method converts the textual representation of a resource file to an actual corresponding SList object.
ParsingFailedException - Exception in com.mackenziehigh.sexpr.exceptions: This type of exception indicates the detection of a syntax-error.
ParsingFailedException(SourceLocation) - Constructor for exception com.mackenziehigh.sexpr.exceptions.ParsingFailedException
pass(String) - Method in class com.mackenziehigh.sexpr.Schema.Builder: Use this method to declare another translation pass.
Pass - Annotation Type in com.mackenziehigh.sexpr.annotations: Use this method to mark a class or method in order to indicate the translation-pass that the class or method related to.
postorder(Predicate<Sexpr<?>>) - Method in class com.mackenziehigh.sexpr.SAtom: This method performs a post-order-search of the tree rooted at this node.
postorder(Predicate<Sexpr<?>>) - Method in interface com.mackenziehigh.sexpr.Sexpr: This method performs a post-order-search of the tree rooted at this node.
postorder(Predicate<Sexpr<?>>) - Method in class com.mackenziehigh.sexpr.SList: This method performs a post-order-search of the tree rooted at this node.
preorder(Predicate<Sexpr<?>>) - Method in class com.mackenziehigh.sexpr.SAtom: This method performs a pre-order-search of the tree rooted at this node.
preorder(Predicate<Sexpr<?>>) - Method in interface com.mackenziehigh.sexpr.Sexpr: This method performs a pre-order-search of the tree rooted at this node.
preorder(Predicate<Sexpr<?>>) - Method in class com.mackenziehigh.sexpr.SList: This method performs a pre-order-search of the tree rooted at this node.
prepend(Sexpr<?>) - Method in class com.mackenziehigh.sexpr.SList.Mutator: This method prepends the given value onto the selected node, if the selected node is a symbolic-list.
print(Object) - Method in class com.mackenziehigh.sexpr.util.StringPrinter: Use this method to print a value to the output string.
printf(String, Object...) - Method in class com.mackenziehigh.sexpr.util.StringPrinter: Use this method to print a formatted value to the output string.
printList(Iterable<?>, String, String, String) - Method in class com.mackenziehigh.sexpr.util.StringPrinter: This method prints the string representation of an iterable.
println() - Method in class com.mackenziehigh.sexpr.util.StringPrinter: Use this method to print a newline to the output string.
println(Object) - Method in class com.mackenziehigh.sexpr.util.StringPrinter: Use this method to print a value and a newline to the output string.
printlns(Iterable<?>) - Method in class com.mackenziehigh.sexpr.util.StringPrinter: Use this method to print a series of values to the output string, one per line.

S

SAtom - Class in com.mackenziehigh.sexpr: Symbolic Atom.
Schema - Class in com.mackenziehigh.sexpr: An instance of this class can be used to determine whether a symbolic-expression matches a pattern.
Schema.Builder - Class in com.mackenziehigh.sexpr: Use an instance of this class to create a Schema object.
Schema.Match - Interface in com.mackenziehigh.sexpr: Result of a match(Sexpr) invocation.
set(Sexpr<?>) - Method in class com.mackenziehigh.sexpr.SList.Mutator: This method sets the selected node to the given value.
setIndent(int) - Method in class com.mackenziehigh.sexpr.util.StringPrinter: Use this method in order to make subsequent output more or less indented.
Sexpr<T extends Sexpr<T>> - Interface in com.mackenziehigh.sexpr: Symbolic Expression.
size() - Method in class com.mackenziehigh.sexpr.SList
SList - Class in com.mackenziehigh.sexpr: Symbolic List.
SList.Mutator - Class in com.mackenziehigh.sexpr: An instance of this interface simplifies the modification of symbolic-expressions, since they are immutable.
source() - Method in class com.mackenziehigh.sexpr.SourceLocation: This method retrieves the name of the source.
SourceLocation - Class in com.mackenziehigh.sexpr: An instance of this interface indicate the location of a symbolic-expression within a string of text.
SourceLocation(String, int, int) - Constructor for class com.mackenziehigh.sexpr.SourceLocation: Sole Constructor.
StringPrinter - Class in com.mackenziehigh.sexpr.util: Instances of this class simplify the creation of indented text.
StringPrinter(int, int) - Constructor for class com.mackenziehigh.sexpr.util.StringPrinter: Sole Constructor.

T

tail() - Method in class com.mackenziehigh.sexpr.SList: This method retrieves the sub-list containing all of the elements of this list, except for the first element in linear-time.
toString() - Method in exception com.mackenziehigh.sexpr.exceptions.ParsingFailedException
toString() - Method in class com.mackenziehigh.sexpr.SAtom: This method retrieves the textual representation of this symbolic expression.
toString() - Method in interface com.mackenziehigh.sexpr.Sexpr: This method retrieves the textual representation of this symbolic expression.
toString() - Method in class com.mackenziehigh.sexpr.SList.Mutator
toString() - Method in class com.mackenziehigh.sexpr.SList: This method retrieves the textual representation of this symbolic expression.
toString() - Method in class com.mackenziehigh.sexpr.SourceLocation
toString() - Method in class com.mackenziehigh.sexpr.util.OutputFile
toString() - Method in class com.mackenziehigh.sexpr.util.StringPrinter
traverse(Consumer<Sexpr<?>>, Consumer<Sexpr<?>>) - Method in class com.mackenziehigh.sexpr.SAtom: This method performs a traversal of the tree rooted at this node.
traverse(Consumer<Sexpr<?>>, Consumer<Sexpr<?>>) - Method in interface com.mackenziehigh.sexpr.Sexpr: This method performs a traversal of the tree rooted at this node.
traverse(Consumer<Sexpr<?>>, Consumer<Sexpr<?>>) - Method in class com.mackenziehigh.sexpr.SList: This method performs a traversal of the tree rooted at this node.
treeHeight() - Method in class com.mackenziehigh.sexpr.SAtom: This method determines the height of the tree rooted at this node.
treeHeight() - Method in interface com.mackenziehigh.sexpr.Sexpr: This method determines the height of the tree rooted at this node.
treeHeight() - Method in class com.mackenziehigh.sexpr.SList: This method determines the height of the tree rooted at this node.
treeLeafCount() - Method in class com.mackenziehigh.sexpr.SAtom: This method counts the leaf nodes in the tree rooted at this node.
treeLeafCount() - Method in interface com.mackenziehigh.sexpr.Sexpr: This method counts the leaf nodes in the tree rooted at this node.
treeLeafCount() - Method in class com.mackenziehigh.sexpr.SList: This method counts the leaf nodes in the tree rooted at this node.
treeSize() - Method in class com.mackenziehigh.sexpr.SAtom: This method counts the nodes in the tree rooted at this node.
treeSize() - Method in interface com.mackenziehigh.sexpr.Sexpr: This method counts the nodes in the tree rooted at this node.
treeSize() - Method in class com.mackenziehigh.sexpr.SList: This method counts the nodes in the tree rooted at this node.

V

validate() - Method in class com.mackenziehigh.sexpr.internal.schema.InternalSchema
value() - Element in annotation type com.mackenziehigh.sexpr.annotations.After: This is the name of the schema rule that this action applies to.
value() - Element in annotation type com.mackenziehigh.sexpr.annotations.Before: This is the name of the schema rule that this action applies to.
value() - Element in annotation type com.mackenziehigh.sexpr.annotations.Condition: This method retrieves user-defined name of the condition.
value() - Element in annotation type com.mackenziehigh.sexpr.annotations.Pass: This method retrieves the user-defined name of the pass.

W

write() - Method in class com.mackenziehigh.sexpr.util.OutputFile: Use this method to write the output file to disk.

A B C D E F G H I L M N O P S T V W
All Classes and Interfaces|All Packages|Serialized Form