Split (1)

train · 1.01M rows

code stringlengths 2.5k 150k	kind stringclasses 1 value
groovy [Java] Class AbstractLexer [Java] Class AbstractLexer ========================== * org.apache.groovy.parser.antlr4.AbstractLexer All Implemented Interfaces and Traits: [SyntaxErrorReportable](../../ginq/dsl/syntaxerrorreportable) ``` public abstract class AbstractLexer extends [Lexer](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html "Lexer") implements [SyntaxErrorReportable](../../ginq/dsl/syntaxerrorreportable) ``` Because antlr4 does not support generating lexer with specified interface, we have to create a super class for it and implement the interface. Inherited fields \| Fields inherited from class \| Fields \| \| `class [Lexer](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html "Lexer")` \| `DEFAULT_MODE, MORE, SKIP, DEFAULT_TOKEN_CHANNEL, HIDDEN, MIN_CHAR_VALUE, MAX_CHAR_VALUE, _input, _token, _tokenStartCharIndex, _tokenStartLine, _tokenStartCharPositionInLine, _hitEOF, _channel, _type, _modeStack, _mode, _text, EOF` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[AbstractLexer](#AbstractLexer(org.antlr.v4.runtime.CharStream))([CharStream](https://www.antlr.org/api/Java/org/antlr/v4/runtime/CharStream.html "CharStream") input)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Lexer](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html "Lexer")` \| `[nextToken](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#nextToken() "nextToken"), [getType](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#getType() "getType"), [mode](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#mode(int) "mode"), [skip](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#skip() "skip"), [reset](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#reset() "reset"), [getInputStream](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#getInputStream() "getInputStream"), [getInputStream](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#getInputStream() "getInputStream"), [getChannel](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#getChannel() "getChannel"), [more](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#more() "more"), [getText](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#getText() "getText"), [setText](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#setText(java.lang.String) "setText"), [setType](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#setType(int) "setType"), [setInputStream](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#setInputStream(org.antlr.v4.runtime.CharStream) "setInputStream"), [emit](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#emit() "emit"), [emit](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#emit(org.antlr.v4.runtime.Token) "emit"), [getToken](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#getToken() "getToken"), [getLine](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#getLine() "getLine"), [setTokenFactory](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#setTokenFactory(org.antlr.v4.runtime.TokenFactory) "setTokenFactory"), [getTokenFactory](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#getTokenFactory() "getTokenFactory"), [popMode](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#popMode() "popMode"), [setChannel](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#setChannel(int) "setChannel"), [getChannelNames](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#getChannelNames() "getChannelNames"), [getModeNames](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#getModeNames() "getModeNames"), [getTokenNames](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#getTokenNames() "getTokenNames"), [getCharIndex](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#getCharIndex() "getCharIndex"), [pushMode](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#pushMode(int) "pushMode"), [emitEOF](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#emitEOF() "emitEOF"), [getAllTokens](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#getAllTokens() "getAllTokens"), [setToken](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#setToken(org.antlr.v4.runtime.Token) "setToken"), [getErrorDisplay](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#getErrorDisplay(int) "getErrorDisplay"), [getErrorDisplay](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#getErrorDisplay(java.lang.String) "getErrorDisplay"), [notifyListeners](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#notifyListeners(org.antlr.v4.runtime.LexerNoViableAltException) "notifyListeners"), [getSourceName](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#getSourceName() "getSourceName"), [getCharPositionInLine](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#getCharPositionInLine() "getCharPositionInLine"), [setCharPositionInLine](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#setCharPositionInLine(int) "setCharPositionInLine"), [getCharErrorDisplay](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#getCharErrorDisplay(int) "getCharErrorDisplay"), [recover](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#recover(org.antlr.v4.runtime.RecognitionException) "recover"), [recover](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#recover(org.antlr.v4.runtime.LexerNoViableAltException) "recover"), [setLine](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#setLine(int) "setLine"), [action](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#action(org.antlr.v4.runtime.RuleContext,%20int,%20int) "action"), [getState](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#getState() "getState"), [setState](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#setState(int) "setState"), [getRuleNames](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#getRuleNames() "getRuleNames"), [getSerializedATN](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#getSerializedATN() "getSerializedATN"), [getATN](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#getATN() "getATN"), [setInterpreter](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#setInterpreter(org.antlr.v4.runtime.atn.ATNSimulator) "setInterpreter"), [sempred](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#sempred(org.antlr.v4.runtime.RuleContext,%20int,%20int) "sempred"), [getVocabulary](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#getVocabulary() "getVocabulary"), [getGrammarFileName](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#getGrammarFileName() "getGrammarFileName"), [getRuleIndexMap](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#getRuleIndexMap() "getRuleIndexMap"), [getErrorHeader](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#getErrorHeader(org.antlr.v4.runtime.RecognitionException) "getErrorHeader"), [getTokenTypeMap](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#getTokenTypeMap() "getTokenTypeMap"), [getTokenType](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#getTokenType(java.lang.String) "getTokenType"), [getParseInfo](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#getParseInfo() "getParseInfo"), [precpred](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#precpred(org.antlr.v4.runtime.RuleContext,%20int) "precpred"), [getErrorListeners](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#getErrorListeners() "getErrorListeners"), [addErrorListener](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#addErrorListener(org.antlr.v4.runtime.ANTLRErrorListener) "addErrorListener"), [removeErrorListeners](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#removeErrorListeners() "removeErrorListeners"), [removeErrorListener](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#removeErrorListener(org.antlr.v4.runtime.ANTLRErrorListener) "removeErrorListener"), [getTokenErrorDisplay](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#getTokenErrorDisplay(org.antlr.v4.runtime.Token) "getTokenErrorDisplay"), [getErrorListenerDispatch](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#getErrorListenerDispatch() "getErrorListenerDispatch"), [getInterpreter](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#getInterpreter() "getInterpreter"), [wait](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#wait(long,%20int) "wait"), [wait](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#wait() "wait"), [wait](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#wait(long) "wait"), [equals](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#equals(java.lang.Object) "equals"), [toString](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#toString() "toString"), [hashCode](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#hashCode() "hashCode"), [getClass](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#getClass() "getClass"), [notify](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#notify() "notify"), [notifyAll](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Lexer.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public AbstractLexer([CharStream](https://www.antlr.org/api/Java/org/antlr/v4/runtime/CharStream.html "CharStream") input) groovy [Java] Class AbstractParser [Java] Class AbstractParser =========================== * org.apache.groovy.parser.antlr4.AbstractParser All Implemented Interfaces and Traits: [SyntaxErrorReportable](../../ginq/dsl/syntaxerrorreportable) ``` public abstract class AbstractParser extends org.apache.groovy.groovysh.Parser implements [SyntaxErrorReportable](../../ginq/dsl/syntaxerrorreportable) ``` Because antlr4 does not support generating parser with specified interface, we have to create a super class for it and implement the interface. Inherited fields \| Fields inherited from class \| Fields \| \| `class org.apache.groovy.groovysh.Parser` \| `__$stMC` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[AbstractParser](#AbstractParser(org.antlr.v4.runtime.TokenStream))([TokenStream](https://www.antlr.org/api/Java/org/antlr/v4/runtime/TokenStream.html "TokenStream") input)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class org.apache.groovy.groovysh.Parser` \| `org.apache.groovy.groovysh.Parser#parse(java.util.Collection), org.apache.groovy.groovysh.Parser#setMetaClass(groovy.lang.MetaClass), org.apache.groovy.groovysh.Parser#getMetaClass(), org.apache.groovy.groovysh.Parser#$getLookup(), org.apache.groovy.groovysh.Parser#getNEWLINE(), org.apache.groovy.groovysh.Parser#wait(long, int), org.apache.groovy.groovysh.Parser#wait(), org.apache.groovy.groovysh.Parser#wait(long), org.apache.groovy.groovysh.Parser#equals(java.lang.Object), org.apache.groovy.groovysh.Parser#toString(), org.apache.groovy.groovysh.Parser#hashCode(), org.apache.groovy.groovysh.Parser#getClass(), org.apache.groovy.groovysh.Parser#notify(), org.apache.groovy.groovysh.Parser#notifyAll(), org.apache.groovy.groovysh.Parser#getProperty(java.lang.String), org.apache.groovy.groovysh.Parser#setProperty(java.lang.String, java.lang.Object), org.apache.groovy.groovysh.Parser#invokeMethod(java.lang.String, java.lang.Object)` \| Constructor Detail ------------------ ### public AbstractParser([TokenStream](https://www.antlr.org/api/Java/org/antlr/v4/runtime/TokenStream.html "TokenStream") input) groovy [Java] Class TryWithResourcesASTTransformation [Java] Class TryWithResourcesASTTransformation ============================================== * org.apache.groovy.parser.antlr4.TryWithResourcesASTTransformation ``` public class TryWithResourcesASTTransformation extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Transform try-with-resources to try-catch-finally Reference JLS "14.20.3. try-with-resources"(https://docs.oracle.com/javase/specs/jls/se7/html/jls-14.html) Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[TryWithResourcesASTTransformation](#TryWithResourcesASTTransformation(org.apache.groovy.parser.antlr4.AstBuilder))([AstBuilder](astbuilder) astBuilder)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [Statement](../../../../codehaus/groovy/ast/stmt/statement)` \| `[transform](#transform(org.codehaus.groovy.ast.stmt.TryCatchStatement))([TryCatchStatement](../../../../codehaus/groovy/ast/stmt/trycatchstatement) tryCatchStatement)`Reference JLS "14.20.3. try-with-resources"(https://docs.oracle.com/javase/specs/jls/se7/html/jls-14.html) \| \| \| `public [BinaryExpression](../../../../codehaus/groovy/ast/expr/binaryexpression)` \| `[transformResourceAccess](#transformResourceAccess(org.codehaus.groovy.ast.expr.Expression))([Expression](../../../../codehaus/groovy/ast/expr/expression) variableAccessExpression)`See https://docs.oracle.com/javase/specs/jls/se9/html/jls-14.html 14.20.3.1. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public TryWithResourcesASTTransformation([AstBuilder](astbuilder) astBuilder) Method Detail ------------- ### public [Statement](../../../../codehaus/groovy/ast/stmt/statement) transform([TryCatchStatement](../../../../codehaus/groovy/ast/stmt/trycatchstatement) tryCatchStatement) Reference JLS "14.20.3. try-with-resources"(https://docs.oracle.com/javase/specs/jls/se7/html/jls-14.html) Parameters: `tryCatchStatement` - the try-with-resources statement to transform Returns: try-catch-finally statement, which contains no resources clause ### public [BinaryExpression](../../../../codehaus/groovy/ast/expr/binaryexpression) transformResourceAccess([Expression](../../../../codehaus/groovy/ast/expr/expression) variableAccessExpression) See https://docs.oracle.com/javase/specs/jls/se9/html/jls-14.html 14.20.3.1. Basic try-with-resources If a basic try-with-resource statement is of the form: try (VariableAccess ...) Block then the resource is first converted to a local variable declaration by the following translation: try (T #r = VariableAccess ...) { Block } groovy [Java] Class GroovySyntaxError [Java] Class GroovySyntaxError ============================== * org.apache.groovy.parser.antlr4.GroovySyntaxError ``` public class GroovySyntaxError extends [AssertionError](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html "AssertionError") ``` Represents a syntax error of groovy program Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `static int` \| `[LEXER](#LEXER)` \| \| \| `static int` \| `[PARSER](#PARSER)` \| \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[GroovySyntaxError](#GroovySyntaxError(java.lang.String,%20int,%20int,%20int))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message, int source, int line, int column)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public int` \| `[getColumn](#getColumn())()` \| \| \| `public int` \| `[getLine](#getLine())()` \| \| \| `public int` \| `[getSource](#getSource())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AssertionError](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html "AssertionError")` \| `[printStackTrace](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html#printStackTrace() "printStackTrace"), [printStackTrace](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html#printStackTrace(java.io.PrintStream) "printStackTrace"), [printStackTrace](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html#printStackTrace(java.io.PrintWriter) "printStackTrace"), [fillInStackTrace](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html#fillInStackTrace() "fillInStackTrace"), [getCause](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html#getCause() "getCause"), [initCause](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html#initCause(java.lang.Throwable) "initCause"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html#toString() "toString"), [getMessage](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html#getMessage() "getMessage"), [getSuppressed](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html#getSuppressed() "getSuppressed"), [getLocalizedMessage](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html#getLocalizedMessage() "getLocalizedMessage"), [getStackTrace](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html#getStackTrace() "getStackTrace"), [setStackTrace](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html#setStackTrace(%5BLjava.lang.StackTraceElement;) "setStackTrace"), [addSuppressed](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html#addSuppressed(java.lang.Throwable) "addSuppressed"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html#equals(java.lang.Object) "equals"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html#notifyAll() "notifyAll")` \| Field Detail ------------ ### public static final int LEXER ### public static final int PARSER Constructor Detail ------------------ ### public GroovySyntaxError([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message, int source, int line, int column) Method Detail ------------- ### public int getColumn() ### public int getLine() ### public int getSource()	programming_docs
groovy [Java] Class SemanticPredicates [Java] Class SemanticPredicates =============================== * org.apache.groovy.parser.antlr4.SemanticPredicates ``` public class SemanticPredicates extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Some semantic predicates for altering the behaviour of the lexer and parser Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public static boolean` \| `[isFollowedBy](#isFollowedBy(org.antlr.v4.runtime.CharStream,%20char))([CharStream](https://www.antlr.org/api/Java/org/antlr/v4/runtime/CharStream.html "CharStream") cs, char chars)` \| \| \| `public static boolean` \| `[isFollowedByJavaLetterInGString](#isFollowedByJavaLetterInGString(org.antlr.v4.runtime.CharStream))([CharStream](https://www.antlr.org/api/Java/org/antlr/v4/runtime/CharStream.html "CharStream") cs)` \| \| \| `public static boolean` \| `[isFollowedByWhiteSpaces](#isFollowedByWhiteSpaces(org.antlr.v4.runtime.CharStream))([CharStream](https://www.antlr.org/api/Java/org/antlr/v4/runtime/CharStream.html "CharStream") cs)` \| \| \| `public static boolean` \| `[isFollowingArgumentsOrClosure](#isFollowingArgumentsOrClosure(org.apache.groovy.parser.antlr4.GroovyParser%24ExpressionContext))(org.apache.groovy.parser.antlr4.GroovyParser$ExpressionContext context)`Check whether following a method name of command expression. \| \| \| `public static boolean` \| `[isInvalidLocalVariableDeclaration](#isInvalidLocalVariableDeclaration(org.antlr.v4.runtime.TokenStream))([TokenStream](https://www.antlr.org/api/Java/org/antlr/v4/runtime/TokenStream.html "TokenStream") ts)`Distinguish between local variable declaration and method call, e.g. \| \| \| `public static boolean` \| `[isInvalidMethodDeclaration](#isInvalidMethodDeclaration(org.antlr.v4.runtime.TokenStream))([TokenStream](https://www.antlr.org/api/Java/org/antlr/v4/runtime/TokenStream.html "TokenStream") ts)`Distinguish between method declaration and method call/constructor declaration \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### public static boolean isFollowedBy([CharStream](https://www.antlr.org/api/Java/org/antlr/v4/runtime/CharStream.html "CharStream") cs, char chars) ### public static boolean isFollowedByJavaLetterInGString([CharStream](https://www.antlr.org/api/Java/org/antlr/v4/runtime/CharStream.html "CharStream") cs) ### public static boolean isFollowedByWhiteSpaces([CharStream](https://www.antlr.org/api/Java/org/antlr/v4/runtime/CharStream.html "CharStream") cs) ### public static boolean isFollowingArgumentsOrClosure(org.apache.groovy.parser.antlr4.GroovyParser$ExpressionContext context) Check whether following a method name of command expression. Method name should not end with "2: arguments" and "3: closure" Parameters: `context` - the preceding expression ### public static boolean isInvalidLocalVariableDeclaration([TokenStream](https://www.antlr.org/api/Java/org/antlr/v4/runtime/TokenStream.html "TokenStream") ts) Distinguish between local variable declaration and method call, e.g. `a b` ### public static boolean isInvalidMethodDeclaration([TokenStream](https://www.antlr.org/api/Java/org/antlr/v4/runtime/TokenStream.html "TokenStream") ts) Distinguish between method declaration and method call/constructor declaration groovy [Java] Class PositionInfo [Java] Class PositionInfo ========================= * org.apache.groovy.parser.antlr4.PositionInfo ``` public class PositionInfo extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[PositionInfo](#PositionInfo(int,%20int))(int line, int column)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public boolean` \| `[equals](#equals(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o)` \| \| \| `public int` \| `[getColumn](#getColumn())()` \| \| \| `public int` \| `[getLine](#getLine())()` \| \| \| `public int` \| `[hashCode](#hashCode())()` \| \| \| `public void` \| `[setColumn](#setColumn(int))(int column)` \| \| \| `public void` \| `[setLine](#setLine(int))(int line)` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[toString](#toString())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public PositionInfo(int line, int column) Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean equals([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o) ### public int getColumn() ### public int getLine() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public int hashCode() ### public void setColumn(int column) ### public void setLine(int line) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") toString() groovy [Java] Class Antlr4PluginFactory [Java] Class Antlr4PluginFactory ================================ * org.apache.groovy.parser.antlr4.Antlr4PluginFactory ``` public class Antlr4PluginFactory extends [ParserPluginFactory](../../../../codehaus/groovy/control/parserpluginfactory) ``` A parser plugin factory for the new parser. Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [ParserPlugin](../../../../codehaus/groovy/control/parserplugin)` \| `[createParserPlugin](#createParserPlugin())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [ParserPluginFactory](../../../../codehaus/groovy/control/parserpluginfactory)` \| `[antlr2](../../../../codehaus/groovy/control/parserpluginfactory#antlr2()), [antlr4](../../../../codehaus/groovy/control/parserpluginfactory#antlr4()), [createParserPlugin](../../../../codehaus/groovy/control/parserpluginfactory#createParserPlugin())` \| Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ParserPlugin](../../../../codehaus/groovy/control/parserplugin) createParserPlugin() groovy [Java] Class GroovyLangParser [Java] Class GroovyLangParser ============================= * org.apache.groovy.parser.antlr4.GroovyLangParser ``` public class GroovyLangParser extends org.apache.groovy.parser.antlr4.GroovyParser ``` The parser for Groovy programming language, which is based on the parser generated by Antlr4 Inherited fields \| Fields inherited from class \| Fields \| \| `class org.apache.groovy.parser.antlr4.GroovyParser` \| `StringLiteral, GStringBegin, GStringEnd, GStringPart, GStringPathPart, RollBackOne, AS, DEF, IN, TRAIT, THREADSAFE, VAR, BuiltInPrimitiveType, ABSTRACT, ASSERT, BREAK, YIELD, CASE, CATCH, CLASS, CONST, CONTINUE, DEFAULT, DO, ELSE, ENUM, EXTENDS, FINAL, FINALLY, FOR, IF, GOTO, IMPLEMENTS, IMPORT, INSTANCEOF, INTERFACE, NATIVE, NEW, NON_SEALED, PACKAGE, PERMITS, PRIVATE, PROTECTED, PUBLIC, RECORD, RETURN, SEALED, STATIC, STRICTFP, SUPER, SWITCH, SYNCHRONIZED, THIS, THROW, THROWS, TRANSIENT, TRY, VOID, VOLATILE, WHILE, IntegerLiteral, FloatingPointLiteral, BooleanLiteral, NullLiteral, RANGE_INCLUSIVE, RANGE_EXCLUSIVE_LEFT, RANGE_EXCLUSIVE_RIGHT, RANGE_EXCLUSIVE_FULL, SPREAD_DOT, SAFE_DOT, SAFE_INDEX, SAFE_CHAIN_DOT, ELVIS, METHOD_POINTER, METHOD_REFERENCE, REGEX_FIND, REGEX_MATCH, POWER, POWER_ASSIGN, SPACESHIP, IDENTICAL, NOT_IDENTICAL, ARROW, NOT_INSTANCEOF, NOT_IN, LPAREN, RPAREN, LBRACE, RBRACE, LBRACK, RBRACK, SEMI, COMMA, DOT, ASSIGN, GT, LT, NOT, BITNOT, QUESTION, COLON, EQUAL, LE, GE, NOTEQUAL, AND, OR, INC, DEC, ADD, SUB, MUL, DIV, BITAND, BITOR, XOR, MOD, ADD_ASSIGN, SUB_ASSIGN, MUL_ASSIGN, DIV_ASSIGN, AND_ASSIGN, OR_ASSIGN, XOR_ASSIGN, MOD_ASSIGN, LSHIFT_ASSIGN, RSHIFT_ASSIGN, URSHIFT_ASSIGN, ELVIS_ASSIGN, CapitalizedIdentifier, Identifier, AT, ELLIPSIS, WS, NL, SH_COMMENT, UNEXPECTED_CHAR, RULE_compilationUnit, RULE_scriptStatements, RULE_scriptStatement, RULE_packageDeclaration, RULE_importDeclaration, RULE_typeDeclaration, RULE_modifier, RULE_modifiersOpt, RULE_modifiers, RULE_classOrInterfaceModifiersOpt, RULE_classOrInterfaceModifiers, RULE_classOrInterfaceModifier, RULE_variableModifier, RULE_variableModifiersOpt, RULE_variableModifiers, RULE_typeParameters, RULE_typeParameter, RULE_typeBound, RULE_typeList, RULE_classDeclaration, RULE_classBody, RULE_enumConstants, RULE_enumConstant, RULE_classBodyDeclaration, RULE_memberDeclaration, RULE_methodDeclaration, RULE_compactConstructorDeclaration, RULE_methodName, RULE_returnType, RULE_fieldDeclaration, RULE_variableDeclarators, RULE_variableDeclarator, RULE_variableDeclaratorId, RULE_variableInitializer, RULE_variableInitializers, RULE_emptyDims, RULE_emptyDimsOpt, RULE_standardType, RULE_type, RULE_classOrInterfaceType, RULE_generalClassOrInterfaceType, RULE_standardClassOrInterfaceType, RULE_primitiveType, RULE_typeArguments, RULE_typeArgument, RULE_annotatedQualifiedClassName, RULE_qualifiedClassNameList, RULE_formalParameters, RULE_formalParameterList, RULE_thisFormalParameter, RULE_formalParameter, RULE_methodBody, RULE_qualifiedName, RULE_qualifiedNameElement, RULE_qualifiedNameElements, RULE_qualifiedClassName, RULE_qualifiedStandardClassName, RULE_literal, RULE_gstring, RULE_gstringValue, RULE_gstringPath, RULE_lambdaExpression, RULE_standardLambdaExpression, RULE_lambdaParameters, RULE_standardLambdaParameters, RULE_lambdaBody, RULE_closure, RULE_closureOrLambdaExpression, RULE_blockStatementsOpt, RULE_blockStatements, RULE_annotationsOpt, RULE_annotation, RULE_elementValues, RULE_annotationName, RULE_elementValuePairs, RULE_elementValuePair, RULE_elementValuePairName, RULE_elementValue, RULE_elementValueArrayInitializer, RULE_block, RULE_blockStatement, RULE_localVariableDeclaration, RULE_variableDeclaration, RULE_typeNamePairs, RULE_typeNamePair, RULE_variableNames, RULE_conditionalStatement, RULE_ifElseStatement, RULE_switchStatement, RULE_loopStatement, RULE_continueStatement, RULE_breakStatement, RULE_yieldStatement, RULE_tryCatchStatement, RULE_assertStatement, RULE_statement, RULE_catchClause, RULE_catchType, RULE_finallyBlock, RULE_resources, RULE_resourceList, RULE_resource, RULE_switchBlockStatementGroup, RULE_switchLabel, RULE_forControl, RULE_enhancedForControl, RULE_classicalForControl, RULE_forInit, RULE_forUpdate, RULE_castParExpression, RULE_parExpression, RULE_expressionInPar, RULE_expressionList, RULE_expressionListElement, RULE_enhancedStatementExpression, RULE_statementExpression, RULE_postfixExpression, RULE_switchExpression, RULE_switchBlockStatementExpressionGroup, RULE_switchExpressionLabel, RULE_expression, RULE_castOperandExpression, RULE_commandExpression, RULE_commandArgument, RULE_pathExpression, RULE_pathElement, RULE_namePart, RULE_dynamicMemberName, RULE_indexPropertyArgs, RULE_namedPropertyArgs, RULE_primary, RULE_namedPropertyArgPrimary, RULE_namedArgPrimary, RULE_commandPrimary, RULE_list, RULE_map, RULE_mapEntryList, RULE_namedPropertyArgList, RULE_mapEntry, RULE_namedPropertyArg, RULE_namedArg, RULE_mapEntryLabel, RULE_namedPropertyArgLabel, RULE_namedArgLabel, RULE_creator, RULE_dim, RULE_arrayInitializer, RULE_anonymousInnerClassDeclaration, RULE_createdName, RULE_nonWildcardTypeArguments, RULE_typeArgumentsOrDiamond, RULE_arguments, RULE_argumentList, RULE_enhancedArgumentListInPar, RULE_firstArgumentListElement, RULE_argumentListElement, RULE_enhancedArgumentListElement, RULE_stringLiteral, RULE_className, RULE_identifier, RULE_builtInType, RULE_keywords, RULE_rparen, RULE_nls, RULE_sep, ruleNames, VOCABULARY, tokenNames, _serializedATN, _ATN, NO_OFFSET, EOF` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[GroovyLangParser](#GroovyLangParser(org.antlr.v4.runtime.TokenStream))([TokenStream](https://www.antlr.org/api/Java/org/antlr/v4/runtime/TokenStream.html "TokenStream") input)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `protected [FailedPredicateException](https://www.antlr.org/api/Java/org/antlr/v4/runtime/FailedPredicateException.html "FailedPredicateException")` \| `[createFailedPredicateException](#createFailedPredicateException(java.lang.String,%20java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") predicate, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class org.apache.groovy.parser.antlr4.GroovyParser` \| `org.apache.groovy.parser.antlr4.GroovyParser#modifiers(), org.apache.groovy.parser.antlr4.GroovyParser#returnType(int), org.apache.groovy.parser.antlr4.GroovyParser#type(), org.apache.groovy.parser.antlr4.GroovyParser#methodName(), org.apache.groovy.parser.antlr4.GroovyParser#className(), org.apache.groovy.parser.antlr4.GroovyParser#map(), org.apache.groovy.parser.antlr4.GroovyParser#list(), org.apache.groovy.parser.antlr4.GroovyParser#enumConstants(), org.apache.groovy.parser.antlr4.GroovyParser#annotation(), org.apache.groovy.parser.antlr4.GroovyParser#resources(), org.apache.groovy.parser.antlr4.GroovyParser#arguments(), org.apache.groovy.parser.antlr4.GroovyParser#primitiveType(), org.apache.groovy.parser.antlr4.GroovyParser#block(), org.apache.groovy.parser.antlr4.GroovyParser#sep(), org.apache.groovy.parser.antlr4.GroovyParser#literal(), org.apache.groovy.parser.antlr4.GroovyParser#catchType(), org.apache.groovy.parser.antlr4.GroovyParser#dim(), org.apache.groovy.parser.antlr4.GroovyParser#closure(), org.apache.groovy.parser.antlr4.GroovyParser#typeList(), org.apache.groovy.parser.antlr4.GroovyParser#resource(), org.apache.groovy.parser.antlr4.GroovyParser#typeParameters(), org.apache.groovy.parser.antlr4.GroovyParser#enumConstant(), org.apache.groovy.parser.antlr4.GroovyParser#expression(), org.apache.groovy.parser.antlr4.GroovyParser#switchBlockStatementGroup(), org.apache.groovy.parser.antlr4.GroovyParser#variableInitializer(), org.apache.groovy.parser.antlr4.GroovyParser#variableDeclaratorId(), org.apache.groovy.parser.antlr4.GroovyParser#variableDeclarators(), org.apache.groovy.parser.antlr4.GroovyParser#lambdaExpression(), org.apache.groovy.parser.antlr4.GroovyParser#identifier(), org.apache.groovy.parser.antlr4.GroovyParser#creator(int), org.apache.groovy.parser.antlr4.GroovyParser#blockStatement(), org.apache.groovy.parser.antlr4.GroovyParser#modifiersOpt(), org.apache.groovy.parser.antlr4.GroovyParser#typeParameter(), org.apache.groovy.parser.antlr4.GroovyParser#pathElement(), org.apache.groovy.parser.antlr4.GroovyParser#typeArgument(), org.apache.groovy.parser.antlr4.GroovyParser#typeArguments(), org.apache.groovy.parser.antlr4.GroovyParser#forInit(), org.apache.groovy.parser.antlr4.GroovyParser#catchClause(), org.apache.groovy.parser.antlr4.GroovyParser#annotationsOpt(), org.apache.groovy.parser.antlr4.GroovyParser#forUpdate(), org.apache.groovy.parser.antlr4.GroovyParser#typeDeclaration(), org.apache.groovy.parser.antlr4.GroovyParser#importDeclaration(), org.apache.groovy.parser.antlr4.GroovyParser#variableDeclarator(), org.apache.groovy.parser.antlr4.GroovyParser#classDeclaration(), org.apache.groovy.parser.antlr4.GroovyParser#formalParameter(), org.apache.groovy.parser.antlr4.GroovyParser#lambdaParameters(), org.apache.groovy.parser.antlr4.GroovyParser#annotationName(), org.apache.groovy.parser.antlr4.GroovyParser#primary(), org.apache.groovy.parser.antlr4.GroovyParser#blockStatements(), org.apache.groovy.parser.antlr4.GroovyParser#statement(), org.apache.groovy.parser.antlr4.GroovyParser#arrayInitializer(), org.apache.groovy.parser.antlr4.GroovyParser#forControl(), org.apache.groovy.parser.antlr4.GroovyParser#argumentList(), org.apache.groovy.parser.antlr4.GroovyParser#nls(), org.apache.groovy.parser.antlr4.GroovyParser#getRuleNames(), org.apache.groovy.parser.antlr4.GroovyParser#getSerializedATN(), org.apache.groovy.parser.antlr4.GroovyParser#variableNames(), org.apache.groovy.parser.antlr4.GroovyParser#sempred(org.antlr.v4.runtime.RuleContext, int, int), org.apache.groovy.parser.antlr4.GroovyParser#getErrorLine(), org.apache.groovy.parser.antlr4.GroovyParser#getVocabulary(), org.apache.groovy.parser.antlr4.GroovyParser#getTokenNames(), org.apache.groovy.parser.antlr4.GroovyParser#getGrammarFileName(), org.apache.groovy.parser.antlr4.GroovyParser#getErrorColumn(), org.apache.groovy.parser.antlr4.GroovyParser#qualifiedName(), org.apache.groovy.parser.antlr4.GroovyParser#compilationUnit(), org.apache.groovy.parser.antlr4.GroovyParser#modifier(), org.apache.groovy.parser.antlr4.GroovyParser#expressionList(boolean), org.apache.groovy.parser.antlr4.GroovyParser#keywords(), org.apache.groovy.parser.antlr4.GroovyParser#rparen(), org.apache.groovy.parser.antlr4.GroovyParser#parExpression(), org.apache.groovy.parser.antlr4.GroovyParser#stringLiteral(), org.apache.groovy.parser.antlr4.GroovyParser#formalParameters(), org.apache.groovy.parser.antlr4.GroovyParser#loopStatement(), org.apache.groovy.parser.antlr4.GroovyParser#resourceList(), org.apache.groovy.parser.antlr4.GroovyParser#finallyBlock(), org.apache.groovy.parser.antlr4.GroovyParser#yieldStatement(), org.apache.groovy.parser.antlr4.GroovyParser#switchLabel(), org.apache.groovy.parser.antlr4.GroovyParser#switchExpression(), org.apache.groovy.parser.antlr4.GroovyParser#qualifiedClassName(), org.apache.groovy.parser.antlr4.GroovyParser#classBody(int), org.apache.groovy.parser.antlr4.GroovyParser#methodBody(), org.apache.groovy.parser.antlr4.GroovyParser#methodDeclaration(int, int), org.apache.groovy.parser.antlr4.GroovyParser#typeBound(), org.apache.groovy.parser.antlr4.GroovyParser#memberDeclaration(int), org.apache.groovy.parser.antlr4.GroovyParser#fieldDeclaration(), org.apache.groovy.parser.antlr4.GroovyParser#elementValue(), org.apache.groovy.parser.antlr4.GroovyParser#typeNamePair(), org.apache.groovy.parser.antlr4.GroovyParser#typeNamePairs(), org.apache.groovy.parser.antlr4.GroovyParser#commandArgument(), org.apache.groovy.parser.antlr4.GroovyParser#blockStatementsOpt(), org.apache.groovy.parser.antlr4.GroovyParser#commandExpression(), org.apache.groovy.parser.antlr4.GroovyParser#indexPropertyArgs(), org.apache.groovy.parser.antlr4.GroovyParser#namedPropertyArgs(), org.apache.groovy.parser.antlr4.GroovyParser#namePart(), org.apache.groovy.parser.antlr4.GroovyParser#gstring(), org.apache.groovy.parser.antlr4.GroovyParser#mapEntry(), org.apache.groovy.parser.antlr4.GroovyParser#dynamicMemberName(), org.apache.groovy.parser.antlr4.GroovyParser#mapEntryList(), org.apache.groovy.parser.antlr4.GroovyParser#castParExpression(), org.apache.groovy.parser.antlr4.GroovyParser#pathExpression(), org.apache.groovy.parser.antlr4.GroovyParser#mapEntryLabel(), org.apache.groovy.parser.antlr4.GroovyParser#createdName(), org.apache.groovy.parser.antlr4.GroovyParser#gstringValue(), org.apache.groovy.parser.antlr4.GroovyParser#gstringPath(), org.apache.groovy.parser.antlr4.GroovyParser#variableModifiers(), org.apache.groovy.parser.antlr4.GroovyParser#emptyDims(), org.apache.groovy.parser.antlr4.GroovyParser#variableModifier(), org.apache.groovy.parser.antlr4.GroovyParser#elementValues(), org.apache.groovy.parser.antlr4.GroovyParser#emptyDimsOpt(), org.apache.groovy.parser.antlr4.GroovyParser#elementValuePairs(), org.apache.groovy.parser.antlr4.GroovyParser#elementValuePair(), org.apache.groovy.parser.antlr4.GroovyParser#tryCatchStatement(), org.apache.groovy.parser.antlr4.GroovyParser#postfixExpression(), org.apache.groovy.parser.antlr4.GroovyParser#switchBlockStatementExpressionGroup(), org.apache.groovy.parser.antlr4.GroovyParser#switchExpressionLabel(), org.apache.groovy.parser.antlr4.GroovyParser#classOrInterfaceModifiersOpt(), org.apache.groovy.parser.antlr4.GroovyParser#qualifiedNameElement(), org.apache.groovy.parser.antlr4.GroovyParser#localVariableDeclaration(), org.apache.groovy.parser.antlr4.GroovyParser#classicalForControl(), org.apache.groovy.parser.antlr4.GroovyParser#compactConstructorDeclaration(), org.apache.groovy.parser.antlr4.GroovyParser#anonymousInnerClassDeclaration(int), org.apache.groovy.parser.antlr4.GroovyParser#qualifiedClassNameList(), org.apache.groovy.parser.antlr4.GroovyParser#enhancedStatementExpression(), org.apache.groovy.parser.antlr4.GroovyParser#variableDeclaration(int), org.apache.groovy.parser.antlr4.GroovyParser#variableInitializers(), org.apache.groovy.parser.antlr4.GroovyParser#classBodyDeclaration(int), org.apache.groovy.parser.antlr4.GroovyParser#enhancedArgumentListInPar(), org.apache.groovy.parser.antlr4.GroovyParser#statementExpression(), org.apache.groovy.parser.antlr4.GroovyParser#standardLambdaParameters(), org.apache.groovy.parser.antlr4.GroovyParser#enhancedArgumentListElement(), org.apache.groovy.parser.antlr4.GroovyParser#formalParameterList(), org.apache.groovy.parser.antlr4.GroovyParser#typeArgumentsOrDiamond(), org.apache.groovy.parser.antlr4.GroovyParser#nonWildcardTypeArguments(), org.apache.groovy.parser.antlr4.GroovyParser#expressionListElement(boolean), org.apache.groovy.parser.antlr4.GroovyParser#closureOrLambdaExpression(), org.apache.groovy.parser.antlr4.GroovyParser#standardLambdaExpression(), org.apache.groovy.parser.antlr4.GroovyParser#elementValuePairName(), org.apache.groovy.parser.antlr4.GroovyParser#annotatedQualifiedClassName(), org.apache.groovy.parser.antlr4.GroovyParser#qualifiedStandardClassName(), org.apache.groovy.parser.antlr4.GroovyParser#elementValueArrayInitializer(), org.apache.groovy.parser.antlr4.GroovyParser#classOrInterfaceModifiers(), org.apache.groovy.parser.antlr4.GroovyParser#classOrInterfaceModifier(), org.apache.groovy.parser.antlr4.GroovyParser#classOrInterfaceType(), org.apache.groovy.parser.antlr4.GroovyParser#variableModifiersOpt(), org.apache.groovy.parser.antlr4.GroovyParser#thisFormalParameter(), org.apache.groovy.parser.antlr4.GroovyParser#qualifiedNameElements(), org.apache.groovy.parser.antlr4.GroovyParser#getSyntaxErrorSource(), org.apache.groovy.parser.antlr4.GroovyParser#enhancedForControl(), org.apache.groovy.parser.antlr4.GroovyParser#expressionInPar(), org.apache.groovy.parser.antlr4.GroovyParser#scriptStatement(), org.apache.groovy.parser.antlr4.GroovyParser#ifElseStatement(), org.apache.groovy.parser.antlr4.GroovyParser#switchStatement(), org.apache.groovy.parser.antlr4.GroovyParser#packageDeclaration(), org.apache.groovy.parser.antlr4.GroovyParser#scriptStatements(), org.apache.groovy.parser.antlr4.GroovyParser#lambdaBody(), org.apache.groovy.parser.antlr4.GroovyParser#standardType(), org.apache.groovy.parser.antlr4.GroovyParser#namedArgLabel(), org.apache.groovy.parser.antlr4.GroovyParser#namedPropertyArg(), org.apache.groovy.parser.antlr4.GroovyParser#continueStatement(), org.apache.groovy.parser.antlr4.GroovyParser#assertStatement(), org.apache.groovy.parser.antlr4.GroovyParser#namedArgPrimary(), org.apache.groovy.parser.antlr4.GroovyParser#builtInType(), org.apache.groovy.parser.antlr4.GroovyParser#breakStatement(), org.apache.groovy.parser.antlr4.GroovyParser#namedArg(), org.apache.groovy.parser.antlr4.GroovyParser#commandPrimary(), org.apache.groovy.parser.antlr4.GroovyParser#namedPropertyArgLabel(), org.apache.groovy.parser.antlr4.GroovyParser#namedPropertyArgList(), org.apache.groovy.parser.antlr4.GroovyParser#generalClassOrInterfaceType(), org.apache.groovy.parser.antlr4.GroovyParser#standardClassOrInterfaceType(), org.apache.groovy.parser.antlr4.GroovyParser#conditionalStatement(), org.apache.groovy.parser.antlr4.GroovyParser#castOperandExpression(), org.apache.groovy.parser.antlr4.GroovyParser#namedPropertyArgPrimary(), org.apache.groovy.parser.antlr4.GroovyParser#firstArgumentListElement(), org.apache.groovy.parser.antlr4.GroovyParser#argumentListElement(), org.apache.groovy.parser.antlr4.GroovyParser#match(int), org.apache.groovy.parser.antlr4.GroovyParser#getContext(), org.apache.groovy.parser.antlr4.GroovyParser#reset(), org.apache.groovy.parser.antlr4.GroovyParser#getInputStream(), org.apache.groovy.parser.antlr4.GroovyParser#getInputStream(), org.apache.groovy.parser.antlr4.GroovyParser#consume(), org.apache.groovy.parser.antlr4.GroovyParser#setInputStream(org.antlr.v4.runtime.TokenStream), org.apache.groovy.parser.antlr4.GroovyParser#setErrorHandler(org.antlr.v4.runtime.ANTLRErrorStrategy), org.apache.groovy.parser.antlr4.GroovyParser#getErrorHandler(), org.apache.groovy.parser.antlr4.GroovyParser#setProfile(boolean), org.apache.groovy.parser.antlr4.GroovyParser#getCurrentToken(), org.apache.groovy.parser.antlr4.GroovyParser#getRuleContext(), org.apache.groovy.parser.antlr4.GroovyParser#getTokenFactory(), org.apache.groovy.parser.antlr4.GroovyParser#enterRule(org.antlr.v4.runtime.ParserRuleContext, int, int), org.apache.groovy.parser.antlr4.GroovyParser#exitRule(), org.apache.groovy.parser.antlr4.GroovyParser#getRuleIndex(java.lang.String), org.apache.groovy.parser.antlr4.GroovyParser#getParseInfo(), org.apache.groovy.parser.antlr4.GroovyParser#precpred(org.antlr.v4.runtime.RuleContext, int), org.apache.groovy.parser.antlr4.GroovyParser#getExpectedTokens(), org.apache.groovy.parser.antlr4.GroovyParser#isTrace(), org.apache.groovy.parser.antlr4.GroovyParser#setTrace(boolean), org.apache.groovy.parser.antlr4.GroovyParser#setContext(org.antlr.v4.runtime.ParserRuleContext), org.apache.groovy.parser.antlr4.GroovyParser#getSourceName(), org.apache.groovy.parser.antlr4.GroovyParser#getPrecedence(), org.apache.groovy.parser.antlr4.GroovyParser#getRuleInvocationStack(), org.apache.groovy.parser.antlr4.GroovyParser#getRuleInvocationStack(org.antlr.v4.runtime.RuleContext), org.apache.groovy.parser.antlr4.GroovyParser#getErrorListenerDispatch(), org.apache.groovy.parser.antlr4.GroovyParser#getErrorListenerDispatch(), org.apache.groovy.parser.antlr4.GroovyParser#enterOuterAlt(org.antlr.v4.runtime.ParserRuleContext, int), org.apache.groovy.parser.antlr4.GroovyParser#enterRecursionRule(org.antlr.v4.runtime.ParserRuleContext, int), org.apache.groovy.parser.antlr4.GroovyParser#enterRecursionRule(org.antlr.v4.runtime.ParserRuleContext, int, int, int), org.apache.groovy.parser.antlr4.GroovyParser#matchWildcard(), org.apache.groovy.parser.antlr4.GroovyParser#getBuildParseTree(), org.apache.groovy.parser.antlr4.GroovyParser#setBuildParseTree(boolean), org.apache.groovy.parser.antlr4.GroovyParser#getTrimParseTree(), org.apache.groovy.parser.antlr4.GroovyParser#getInvokingContext(int), org.apache.groovy.parser.antlr4.GroovyParser#dumpDFA(), org.apache.groovy.parser.antlr4.GroovyParser#createTerminalNode(org.antlr.v4.runtime.ParserRuleContext, org.antlr.v4.runtime.Token), org.apache.groovy.parser.antlr4.GroovyParser#setTrimParseTree(boolean), org.apache.groovy.parser.antlr4.GroovyParser#getParseListeners(), org.apache.groovy.parser.antlr4.GroovyParser#createErrorNode(org.antlr.v4.runtime.ParserRuleContext, org.antlr.v4.runtime.Token), org.apache.groovy.parser.antlr4.GroovyParser#inContext(java.lang.String), org.apache.groovy.parser.antlr4.GroovyParser#addParseListener(org.antlr.v4.runtime.tree.ParseTreeListener), org.apache.groovy.parser.antlr4.GroovyParser#isMatchedEOF(), org.apache.groovy.parser.antlr4.GroovyParser#isExpectedToken(int), org.apache.groovy.parser.antlr4.GroovyParser#getDFAStrings(), org.apache.groovy.parser.antlr4.GroovyParser#pushNewRecursionContext(org.antlr.v4.runtime.ParserRuleContext, int, int), org.apache.groovy.parser.antlr4.GroovyParser#unrollRecursionContexts(org.antlr.v4.runtime.ParserRuleContext), org.apache.groovy.parser.antlr4.GroovyParser#notifyErrorListeners(org.antlr.v4.runtime.Token, java.lang.String, org.antlr.v4.runtime.RecognitionException), org.apache.groovy.parser.antlr4.GroovyParser#notifyErrorListeners(java.lang.String), org.apache.groovy.parser.antlr4.GroovyParser#getNumberOfSyntaxErrors(), org.apache.groovy.parser.antlr4.GroovyParser#removeParseListeners(), org.apache.groovy.parser.antlr4.GroovyParser#enterLeftFactoredRule(org.antlr.v4.runtime.ParserRuleContext, int, int), org.apache.groovy.parser.antlr4.GroovyParser#removeParseListener(org.antlr.v4.runtime.tree.ParseTreeListener), org.apache.groovy.parser.antlr4.GroovyParser#compileParseTreePattern(java.lang.String, int, org.antlr.v4.runtime.Lexer), org.apache.groovy.parser.antlr4.GroovyParser#compileParseTreePattern(java.lang.String, int), org.apache.groovy.parser.antlr4.GroovyParser#getExpectedTokensWithinCurrentRule(), org.apache.groovy.parser.antlr4.GroovyParser#getATNWithBypassAlts(), org.apache.groovy.parser.antlr4.GroovyParser#action(org.antlr.v4.runtime.RuleContext, int, int), org.apache.groovy.parser.antlr4.GroovyParser#getState(), org.apache.groovy.parser.antlr4.GroovyParser#setState(int), org.apache.groovy.parser.antlr4.GroovyParser#getATN(), org.apache.groovy.parser.antlr4.GroovyParser#setInterpreter(org.antlr.v4.runtime.atn.ATNSimulator), org.apache.groovy.parser.antlr4.GroovyParser#getRuleIndexMap(), org.apache.groovy.parser.antlr4.GroovyParser#getErrorHeader(org.antlr.v4.runtime.RecognitionException), org.apache.groovy.parser.antlr4.GroovyParser#getTokenTypeMap(), org.apache.groovy.parser.antlr4.GroovyParser#getTokenType(java.lang.String), org.apache.groovy.parser.antlr4.GroovyParser#getErrorListeners(), org.apache.groovy.parser.antlr4.GroovyParser#addErrorListener(org.antlr.v4.runtime.ANTLRErrorListener), org.apache.groovy.parser.antlr4.GroovyParser#removeErrorListeners(), org.apache.groovy.parser.antlr4.GroovyParser#removeErrorListener(org.antlr.v4.runtime.ANTLRErrorListener), org.apache.groovy.parser.antlr4.GroovyParser#getTokenErrorDisplay(org.antlr.v4.runtime.Token), org.apache.groovy.parser.antlr4.GroovyParser#getInterpreter(), org.apache.groovy.parser.antlr4.GroovyParser#wait(long, int), org.apache.groovy.parser.antlr4.GroovyParser#wait(), org.apache.groovy.parser.antlr4.GroovyParser#wait(long), org.apache.groovy.parser.antlr4.GroovyParser#equals(java.lang.Object), org.apache.groovy.parser.antlr4.GroovyParser#toString(), org.apache.groovy.parser.antlr4.GroovyParser#hashCode(), org.apache.groovy.parser.antlr4.GroovyParser#getClass(), org.apache.groovy.parser.antlr4.GroovyParser#notify(), org.apache.groovy.parser.antlr4.GroovyParser#notifyAll(), org.apache.groovy.parser.antlr4.GroovyParser#require(boolean, java.lang.String, groovy.lang.Tuple2), org.apache.groovy.parser.antlr4.GroovyParser#require(boolean, java.lang.String), org.apache.groovy.parser.antlr4.GroovyParser#require(boolean, java.lang.String, int, boolean), org.apache.groovy.parser.antlr4.GroovyParser#require(boolean, java.lang.String, int), org.apache.groovy.parser.antlr4.GroovyParser#require(boolean, java.lang.String, boolean), org.apache.groovy.parser.antlr4.GroovyParser#require(boolean, java.lang.String, groovy.lang.Tuple2, boolean), org.apache.groovy.parser.antlr4.GroovyParser#throwSyntaxError(java.lang.String, groovy.lang.Tuple2, boolean), org.apache.groovy.parser.antlr4.GroovyParser#throwSyntaxError(java.lang.String, int, boolean), org.apache.groovy.parser.antlr4.GroovyParser#genPositionInfo(int), org.apache.groovy.parser.antlr4.GroovyParser#genPositionInfo(groovy.lang.Tuple2)` \| Constructor Detail ------------------ ### public GroovyLangParser([TokenStream](https://www.antlr.org/api/Java/org/antlr/v4/runtime/TokenStream.html "TokenStream") input) Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected [FailedPredicateException](https://www.antlr.org/api/Java/org/antlr/v4/runtime/FailedPredicateException.html "FailedPredicateException") createFailedPredicateException([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") predicate, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message)	programming_docs
groovy [Java] Class GroovyLangLexer [Java] Class GroovyLangLexer ============================ * org.apache.groovy.parser.antlr4.GroovyLangLexer ``` public class GroovyLangLexer extends org.apache.groovy.parser.antlr4.GroovyLexer ``` The lexer for Groovy programming language, which is based on the lexer generated by Antlr4 Inherited fields \| Fields inherited from class \| Fields \| \| `class org.apache.groovy.parser.antlr4.GroovyLexer` \| `StringLiteral, GStringBegin, GStringEnd, GStringPart, GStringPathPart, RollBackOne, AS, DEF, IN, TRAIT, THREADSAFE, VAR, BuiltInPrimitiveType, ABSTRACT, ASSERT, BREAK, YIELD, CASE, CATCH, CLASS, CONST, CONTINUE, DEFAULT, DO, ELSE, ENUM, EXTENDS, FINAL, FINALLY, FOR, IF, GOTO, IMPLEMENTS, IMPORT, INSTANCEOF, INTERFACE, NATIVE, NEW, NON_SEALED, PACKAGE, PERMITS, PRIVATE, PROTECTED, PUBLIC, RECORD, RETURN, SEALED, STATIC, STRICTFP, SUPER, SWITCH, SYNCHRONIZED, THIS, THROW, THROWS, TRANSIENT, TRY, VOID, VOLATILE, WHILE, IntegerLiteral, FloatingPointLiteral, BooleanLiteral, NullLiteral, RANGE_INCLUSIVE, RANGE_EXCLUSIVE_LEFT, RANGE_EXCLUSIVE_RIGHT, RANGE_EXCLUSIVE_FULL, SPREAD_DOT, SAFE_DOT, SAFE_INDEX, SAFE_CHAIN_DOT, ELVIS, METHOD_POINTER, METHOD_REFERENCE, REGEX_FIND, REGEX_MATCH, POWER, POWER_ASSIGN, SPACESHIP, IDENTICAL, NOT_IDENTICAL, ARROW, NOT_INSTANCEOF, NOT_IN, LPAREN, RPAREN, LBRACE, RBRACE, LBRACK, RBRACK, SEMI, COMMA, DOT, ASSIGN, GT, LT, NOT, BITNOT, QUESTION, COLON, EQUAL, LE, GE, NOTEQUAL, AND, OR, INC, DEC, ADD, SUB, MUL, DIV, BITAND, BITOR, XOR, MOD, ADD_ASSIGN, SUB_ASSIGN, MUL_ASSIGN, DIV_ASSIGN, AND_ASSIGN, OR_ASSIGN, XOR_ASSIGN, MOD_ASSIGN, LSHIFT_ASSIGN, RSHIFT_ASSIGN, URSHIFT_ASSIGN, ELVIS_ASSIGN, CapitalizedIdentifier, Identifier, AT, ELLIPSIS, WS, NL, SH_COMMENT, UNEXPECTED_CHAR, DQ_GSTRING_MODE, TDQ_GSTRING_MODE, SLASHY_GSTRING_MODE, DOLLAR_SLASHY_GSTRING_MODE, GSTRING_TYPE_SELECTOR_MODE, GSTRING_PATH_MODE, channelNames, modeNames, ruleNames, VOCABULARY, tokenNames, _serializedATN, _ATN, NO_OFFSET, DEFAULT_MODE, MORE, SKIP, DEFAULT_TOKEN_CHANNEL, HIDDEN, MIN_CHAR_VALUE, MAX_CHAR_VALUE, _input, _token, _tokenStartCharIndex, _tokenStartLine, _tokenStartCharPositionInLine, _hitEOF, _channel, _type, _modeStack, _mode, _text, EOF` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[GroovyLangLexer](#GroovyLangLexer(java.io.Reader))([Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") reader)` \| \| `[GroovyLangLexer](#GroovyLangLexer(org.antlr.v4.runtime.CharStream))([CharStream](https://www.antlr.org/api/Java/org/antlr/v4/runtime/CharStream.html "CharStream") input)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public void` \| `[recover](#recover(org.antlr.v4.runtime.LexerNoViableAltException))([LexerNoViableAltException](https://www.antlr.org/api/Java/org/antlr/v4/runtime/LexerNoViableAltException.html "LexerNoViableAltException") e)` \| \| \| `protected void` \| `[rollbackOneChar](#rollbackOneChar())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class org.apache.groovy.parser.antlr4.GroovyLexer` \| `org.apache.groovy.parser.antlr4.GroovyLexer#action(org.antlr.v4.runtime.RuleContext, int, int), org.apache.groovy.parser.antlr4.GroovyLexer#emit(org.antlr.v4.runtime.Token), org.apache.groovy.parser.antlr4.GroovyLexer#getRuleNames(), org.apache.groovy.parser.antlr4.GroovyLexer#getSerializedATN(), org.apache.groovy.parser.antlr4.GroovyLexer#popMode(), org.apache.groovy.parser.antlr4.GroovyLexer#getChannelNames(), org.apache.groovy.parser.antlr4.GroovyLexer#getModeNames(), org.apache.groovy.parser.antlr4.GroovyLexer#sempred(org.antlr.v4.runtime.RuleContext, int, int), org.apache.groovy.parser.antlr4.GroovyLexer#getErrorLine(), org.apache.groovy.parser.antlr4.GroovyLexer#isErrorIgnored(), org.apache.groovy.parser.antlr4.GroovyLexer#getVocabulary(), org.apache.groovy.parser.antlr4.GroovyLexer#getTokenNames(), org.apache.groovy.parser.antlr4.GroovyLexer#getGrammarFileName(), org.apache.groovy.parser.antlr4.GroovyLexer#getErrorColumn(), org.apache.groovy.parser.antlr4.GroovyLexer#setErrorIgnored(boolean), org.apache.groovy.parser.antlr4.GroovyLexer#getSyntaxErrorSource(), org.apache.groovy.parser.antlr4.GroovyLexer#nextToken(), org.apache.groovy.parser.antlr4.GroovyLexer#getType(), org.apache.groovy.parser.antlr4.GroovyLexer#mode(int), org.apache.groovy.parser.antlr4.GroovyLexer#skip(), org.apache.groovy.parser.antlr4.GroovyLexer#reset(), org.apache.groovy.parser.antlr4.GroovyLexer#getInputStream(), org.apache.groovy.parser.antlr4.GroovyLexer#getInputStream(), org.apache.groovy.parser.antlr4.GroovyLexer#getChannel(), org.apache.groovy.parser.antlr4.GroovyLexer#more(), org.apache.groovy.parser.antlr4.GroovyLexer#getText(), org.apache.groovy.parser.antlr4.GroovyLexer#setText(java.lang.String), org.apache.groovy.parser.antlr4.GroovyLexer#setType(int), org.apache.groovy.parser.antlr4.GroovyLexer#setInputStream(org.antlr.v4.runtime.CharStream), org.apache.groovy.parser.antlr4.GroovyLexer#emit(), org.apache.groovy.parser.antlr4.GroovyLexer#getToken(), org.apache.groovy.parser.antlr4.GroovyLexer#getLine(), org.apache.groovy.parser.antlr4.GroovyLexer#setTokenFactory(org.antlr.v4.runtime.TokenFactory), org.apache.groovy.parser.antlr4.GroovyLexer#getTokenFactory(), org.apache.groovy.parser.antlr4.GroovyLexer#setChannel(int), org.apache.groovy.parser.antlr4.GroovyLexer#getCharIndex(), org.apache.groovy.parser.antlr4.GroovyLexer#pushMode(int), org.apache.groovy.parser.antlr4.GroovyLexer#emitEOF(), org.apache.groovy.parser.antlr4.GroovyLexer#getAllTokens(), org.apache.groovy.parser.antlr4.GroovyLexer#setToken(org.antlr.v4.runtime.Token), org.apache.groovy.parser.antlr4.GroovyLexer#getErrorDisplay(int), org.apache.groovy.parser.antlr4.GroovyLexer#getErrorDisplay(java.lang.String), org.apache.groovy.parser.antlr4.GroovyLexer#notifyListeners(org.antlr.v4.runtime.LexerNoViableAltException), org.apache.groovy.parser.antlr4.GroovyLexer#getSourceName(), org.apache.groovy.parser.antlr4.GroovyLexer#getCharPositionInLine(), org.apache.groovy.parser.antlr4.GroovyLexer#setCharPositionInLine(int), org.apache.groovy.parser.antlr4.GroovyLexer#getCharErrorDisplay(int), org.apache.groovy.parser.antlr4.GroovyLexer#recover(org.antlr.v4.runtime.RecognitionException), org.apache.groovy.parser.antlr4.GroovyLexer#recover(org.antlr.v4.runtime.LexerNoViableAltException), org.apache.groovy.parser.antlr4.GroovyLexer#setLine(int), org.apache.groovy.parser.antlr4.GroovyLexer#getState(), org.apache.groovy.parser.antlr4.GroovyLexer#setState(int), org.apache.groovy.parser.antlr4.GroovyLexer#getATN(), org.apache.groovy.parser.antlr4.GroovyLexer#setInterpreter(org.antlr.v4.runtime.atn.ATNSimulator), org.apache.groovy.parser.antlr4.GroovyLexer#getRuleIndexMap(), org.apache.groovy.parser.antlr4.GroovyLexer#getErrorHeader(org.antlr.v4.runtime.RecognitionException), org.apache.groovy.parser.antlr4.GroovyLexer#getTokenTypeMap(), org.apache.groovy.parser.antlr4.GroovyLexer#getTokenType(java.lang.String), org.apache.groovy.parser.antlr4.GroovyLexer#getParseInfo(), org.apache.groovy.parser.antlr4.GroovyLexer#precpred(org.antlr.v4.runtime.RuleContext, int), org.apache.groovy.parser.antlr4.GroovyLexer#getErrorListeners(), org.apache.groovy.parser.antlr4.GroovyLexer#addErrorListener(org.antlr.v4.runtime.ANTLRErrorListener), org.apache.groovy.parser.antlr4.GroovyLexer#removeErrorListeners(), org.apache.groovy.parser.antlr4.GroovyLexer#removeErrorListener(org.antlr.v4.runtime.ANTLRErrorListener), org.apache.groovy.parser.antlr4.GroovyLexer#getTokenErrorDisplay(org.antlr.v4.runtime.Token), org.apache.groovy.parser.antlr4.GroovyLexer#getErrorListenerDispatch(), org.apache.groovy.parser.antlr4.GroovyLexer#getInterpreter(), org.apache.groovy.parser.antlr4.GroovyLexer#wait(long, int), org.apache.groovy.parser.antlr4.GroovyLexer#wait(), org.apache.groovy.parser.antlr4.GroovyLexer#wait(long), org.apache.groovy.parser.antlr4.GroovyLexer#equals(java.lang.Object), org.apache.groovy.parser.antlr4.GroovyLexer#toString(), org.apache.groovy.parser.antlr4.GroovyLexer#hashCode(), org.apache.groovy.parser.antlr4.GroovyLexer#getClass(), org.apache.groovy.parser.antlr4.GroovyLexer#notify(), org.apache.groovy.parser.antlr4.GroovyLexer#notifyAll(), org.apache.groovy.parser.antlr4.GroovyLexer#require(boolean, java.lang.String, groovy.lang.Tuple2), org.apache.groovy.parser.antlr4.GroovyLexer#require(boolean, java.lang.String), org.apache.groovy.parser.antlr4.GroovyLexer#require(boolean, java.lang.String, int, boolean), org.apache.groovy.parser.antlr4.GroovyLexer#require(boolean, java.lang.String, int), org.apache.groovy.parser.antlr4.GroovyLexer#require(boolean, java.lang.String, boolean), org.apache.groovy.parser.antlr4.GroovyLexer#require(boolean, java.lang.String, groovy.lang.Tuple2, boolean), org.apache.groovy.parser.antlr4.GroovyLexer#throwSyntaxError(java.lang.String, groovy.lang.Tuple2, boolean), org.apache.groovy.parser.antlr4.GroovyLexer#throwSyntaxError(java.lang.String, int, boolean), org.apache.groovy.parser.antlr4.GroovyLexer#genPositionInfo(int), org.apache.groovy.parser.antlr4.GroovyLexer#genPositionInfo(groovy.lang.Tuple2)` \| Constructor Detail ------------------ ### public GroovyLangLexer([Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") reader) ### public GroovyLangLexer([CharStream](https://www.antlr.org/api/Java/org/antlr/v4/runtime/CharStream.html "CharStream") input) Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void recover([LexerNoViableAltException](https://www.antlr.org/api/Java/org/antlr/v4/runtime/LexerNoViableAltException.html "LexerNoViableAltException") e) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected void rollbackOneChar() groovy [Java] Class AstBuilder [Java] Class AstBuilder ======================= * org.apache.groovy.parser.antlr4.AstBuilder ``` public class AstBuilder extends org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor ``` Builds the AST from the parse tree generated by Antlr4. Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[AstBuilder](#AstBuilder(org.codehaus.groovy.control.SourceUnit,%20boolean,%20boolean))([SourceUnit](../../../../codehaus/groovy/control/sourceunit) sourceUnit, boolean groovydocEnabled, boolean runtimeGroovydocEnabled)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [BlockStatement](../../../../codehaus/groovy/ast/stmt/blockstatement)` \| `[appendStatementsToBlockStatement](#appendStatementsToBlockStatement(org.codehaus.groovy.ast.stmt.BlockStatement,%20org.codehaus.groovy.ast.stmt.Statement))([BlockStatement](../../../../codehaus/groovy/ast/stmt/blockstatement) bs, [Statement](../../../../codehaus/groovy/ast/stmt/statement) statements)` \| \| \| `public [ModuleNode](../../../../codehaus/groovy/ast/modulenode)` \| `[buildAST](#buildAST())()` \| \| \| `public void` \| `[syntaxError](#syntaxError(org.antlr.v4.runtime.Recognizer,%20java.lang.Object,%20int,%20int,%20java.lang.String,%20org.antlr.v4.runtime.RecognitionException))([Recognizer](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Recognizer.html "Recognizer") recognizer, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") offendingSymbol, int line, int charPositionInLine, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") msg, [RecognitionException](https://www.antlr.org/api/Java/org/antlr/v4/runtime/RecognitionException.html "RecognitionException") e)` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[visit](#visit(org.antlr.v4.runtime.tree.ParseTree))([ParseTree](https://www.antlr.org/api/Java/org/antlr/v4/runtime/tree/ParseTree.html "ParseTree") tree)`Visit tree safely, no NPE occurred when the tree is null. \| \| \| `public [BinaryExpression](../../../../codehaus/groovy/ast/expr/binaryexpression)` \| `[visitAdditiveExprAlt](#visitAdditiveExprAlt(org.apache.groovy.parser.antlr4.GroovyParser%24AdditiveExprAltContext))(org.apache.groovy.parser.antlr4.GroovyParser$AdditiveExprAltContext ctx)` \| \| \| `public [BinaryExpression](../../../../codehaus/groovy/ast/expr/binaryexpression)` \| `[visitAndExprAlt](#visitAndExprAlt(org.apache.groovy.parser.antlr4.GroovyParser%24AndExprAltContext))(org.apache.groovy.parser.antlr4.GroovyParser$AndExprAltContext ctx)` \| \| \| `public [ClassNode](../../../../codehaus/groovy/ast/classnode)` \| `[visitAnnotatedQualifiedClassName](#visitAnnotatedQualifiedClassName(org.apache.groovy.parser.antlr4.GroovyParser%24AnnotatedQualifiedClassNameContext))(org.apache.groovy.parser.antlr4.GroovyParser$AnnotatedQualifiedClassNameContext ctx)` \| \| \| `public [AnnotationNode](../../../../codehaus/groovy/ast/annotationnode)` \| `[visitAnnotation](#visitAnnotation(org.apache.groovy.parser.antlr4.GroovyParser%24AnnotationContext))(org.apache.groovy.parser.antlr4.GroovyParser$AnnotationContext ctx)` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[visitAnnotationName](#visitAnnotationName(org.apache.groovy.parser.antlr4.GroovyParser%24AnnotationNameContext))(org.apache.groovy.parser.antlr4.GroovyParser$AnnotationNameContext ctx)` \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[AnnotationNode](../../../../codehaus/groovy/ast/annotationnode "AnnotationNode")>` \| `[visitAnnotationsOpt](#visitAnnotationsOpt(org.apache.groovy.parser.antlr4.GroovyParser%24AnnotationsOptContext))(org.apache.groovy.parser.antlr4.GroovyParser$AnnotationsOptContext ctx)` \| \| \| `public [InnerClassNode](../../../../codehaus/groovy/ast/innerclassnode)` \| `[visitAnonymousInnerClassDeclaration](#visitAnonymousInnerClassDeclaration(org.apache.groovy.parser.antlr4.GroovyParser%24AnonymousInnerClassDeclarationContext))(org.apache.groovy.parser.antlr4.GroovyParser$AnonymousInnerClassDeclarationContext ctx)` \| \| \| `public [Expression](../../../../codehaus/groovy/ast/expr/expression)` \| `[visitArguments](#visitArguments(org.apache.groovy.parser.antlr4.GroovyParser%24ArgumentsContext))(org.apache.groovy.parser.antlr4.GroovyParser$ArgumentsContext ctx)` \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Expression](../../../../codehaus/groovy/ast/expr/expression "Expression")>` \| `[visitArrayInitializer](#visitArrayInitializer(org.apache.groovy.parser.antlr4.GroovyParser%24ArrayInitializerContext))(org.apache.groovy.parser.antlr4.GroovyParser$ArrayInitializerContext ctx)` \| \| \| `public [AssertStatement](../../../../codehaus/groovy/ast/stmt/assertstatement)` \| `[visitAssertStatement](#visitAssertStatement(org.apache.groovy.parser.antlr4.GroovyParser%24AssertStatementContext))(org.apache.groovy.parser.antlr4.GroovyParser$AssertStatementContext ctx)` \| \| \| `public [BinaryExpression](../../../../codehaus/groovy/ast/expr/binaryexpression)` \| `[visitAssignmentExprAlt](#visitAssignmentExprAlt(org.apache.groovy.parser.antlr4.GroovyParser%24AssignmentExprAltContext))(org.apache.groovy.parser.antlr4.GroovyParser$AssignmentExprAltContext ctx)` \| \| \| `public [Statement](../../../../codehaus/groovy/ast/stmt/statement)` \| `[visitBlock](#visitBlock(org.apache.groovy.parser.antlr4.GroovyParser%24BlockContext))(org.apache.groovy.parser.antlr4.GroovyParser$BlockContext ctx)` \| \| \| `public [Statement](../../../../codehaus/groovy/ast/stmt/statement)` \| `[visitBlockStatement](#visitBlockStatement(org.apache.groovy.parser.antlr4.GroovyParser%24BlockStatementContext))(org.apache.groovy.parser.antlr4.GroovyParser$BlockStatementContext ctx)` \| \| \| `public [BlockStatement](../../../../codehaus/groovy/ast/stmt/blockstatement)` \| `[visitBlockStatements](#visitBlockStatements(org.apache.groovy.parser.antlr4.GroovyParser%24BlockStatementsContext))(org.apache.groovy.parser.antlr4.GroovyParser$BlockStatementsContext ctx)` \| \| \| `public [BlockStatement](../../../../codehaus/groovy/ast/stmt/blockstatement)` \| `[visitBlockStatementsOpt](#visitBlockStatementsOpt(org.apache.groovy.parser.antlr4.GroovyParser%24BlockStatementsOptContext))(org.apache.groovy.parser.antlr4.GroovyParser$BlockStatementsOptContext ctx)` \| \| \| `public [ConstantExpression](../../../../codehaus/groovy/ast/expr/constantexpression)` \| `[visitBooleanLiteralAlt](#visitBooleanLiteralAlt(org.apache.groovy.parser.antlr4.GroovyParser%24BooleanLiteralAltContext))(org.apache.groovy.parser.antlr4.GroovyParser$BooleanLiteralAltContext ctx)` \| \| \| `public [BreakStatement](../../../../codehaus/groovy/ast/stmt/breakstatement)` \| `[visitBreakStatement](#visitBreakStatement(org.apache.groovy.parser.antlr4.GroovyParser%24BreakStatementContext))(org.apache.groovy.parser.antlr4.GroovyParser$BreakStatementContext ctx)` \| \| \| `public [VariableExpression](../../../../codehaus/groovy/ast/expr/variableexpression)` \| `[visitBuiltInType](#visitBuiltInType(org.apache.groovy.parser.antlr4.GroovyParser%24BuiltInTypeContext))(org.apache.groovy.parser.antlr4.GroovyParser$BuiltInTypeContext ctx)` \| \| \| `public [CastExpression](../../../../codehaus/groovy/ast/expr/castexpression)` \| `[visitCastExprAlt](#visitCastExprAlt(org.apache.groovy.parser.antlr4.GroovyParser%24CastExprAltContext))(org.apache.groovy.parser.antlr4.GroovyParser$CastExprAltContext ctx)` \| \| \| `public [ClassNode](../../../../codehaus/groovy/ast/classnode)` \| `[visitCastParExpression](#visitCastParExpression(org.apache.groovy.parser.antlr4.GroovyParser%24CastParExpressionContext))(org.apache.groovy.parser.antlr4.GroovyParser$CastParExpressionContext ctx)` \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[CatchStatement](../../../../codehaus/groovy/ast/stmt/catchstatement "CatchStatement")>` \| `[visitCatchClause](#visitCatchClause(org.apache.groovy.parser.antlr4.GroovyParser%24CatchClauseContext))(org.apache.groovy.parser.antlr4.GroovyParser$CatchClauseContext ctx)`Multi-catch(1..\) clause will be unpacked to several normal catch clauses, so the return type is List \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[ClassNode](../../../../codehaus/groovy/ast/classnode "ClassNode")>` \| `[visitCatchType](#visitCatchType(org.apache.groovy.parser.antlr4.GroovyParser%24CatchTypeContext))(org.apache.groovy.parser.antlr4.GroovyParser$CatchTypeContext ctx)` \| \| \| `public [Void](https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html "Void")` \| `[visitClassBody](#visitClassBody(org.apache.groovy.parser.antlr4.GroovyParser%24ClassBodyContext))(org.apache.groovy.parser.antlr4.GroovyParser$ClassBodyContext ctx)` \| \| \| `public [Void](https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html "Void")` \| `[visitClassBodyDeclaration](#visitClassBodyDeclaration(org.apache.groovy.parser.antlr4.GroovyParser%24ClassBodyDeclarationContext))(org.apache.groovy.parser.antlr4.GroovyParser$ClassBodyDeclarationContext ctx)` \| \| \| `public [ClassNode](../../../../codehaus/groovy/ast/classnode)` \| `[visitClassDeclaration](#visitClassDeclaration(org.apache.groovy.parser.antlr4.GroovyParser%24ClassDeclarationContext))(org.apache.groovy.parser.antlr4.GroovyParser$ClassDeclarationContext ctx)` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[visitClassName](#visitClassName(org.apache.groovy.parser.antlr4.GroovyParser%24ClassNameContext))(org.apache.groovy.parser.antlr4.GroovyParser$ClassNameContext ctx)` \| \| \| `public [ModifierNode](../../../../codehaus/groovy/ast/modifiernode)` \| `[visitClassOrInterfaceModifier](#visitClassOrInterfaceModifier(org.apache.groovy.parser.antlr4.GroovyParser%24ClassOrInterfaceModifierContext))(org.apache.groovy.parser.antlr4.GroovyParser$ClassOrInterfaceModifierContext ctx)` \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[ModifierNode](../../../../codehaus/groovy/ast/modifiernode "ModifierNode")>` \| `[visitClassOrInterfaceModifiers](#visitClassOrInterfaceModifiers(org.apache.groovy.parser.antlr4.GroovyParser%24ClassOrInterfaceModifiersContext))(org.apache.groovy.parser.antlr4.GroovyParser$ClassOrInterfaceModifiersContext ctx)` \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[ModifierNode](../../../../codehaus/groovy/ast/modifiernode "ModifierNode")>` \| `[visitClassOrInterfaceModifiersOpt](#visitClassOrInterfaceModifiersOpt(org.apache.groovy.parser.antlr4.GroovyParser%24ClassOrInterfaceModifiersOptContext))(org.apache.groovy.parser.antlr4.GroovyParser$ClassOrInterfaceModifiersOptContext ctx)` \| \| \| `public [ClassNode](../../../../codehaus/groovy/ast/classnode)` \| `[visitClassOrInterfaceType](#visitClassOrInterfaceType(org.apache.groovy.parser.antlr4.GroovyParser%24ClassOrInterfaceTypeContext))(org.apache.groovy.parser.antlr4.GroovyParser$ClassOrInterfaceTypeContext ctx)` \| \| \| `public [Tuple2](../../../../../groovy/lang/tuple2 "Tuple2")<[Parameter](../../../../codehaus/groovy/ast/parameter "Parameter"), [Expression](../../../../codehaus/groovy/ast/expr/expression "Expression")>` \| `[visitClassicalForControl](#visitClassicalForControl(org.apache.groovy.parser.antlr4.GroovyParser%24ClassicalForControlContext))(org.apache.groovy.parser.antlr4.GroovyParser$ClassicalForControlContext ctx)` \| \| \| `public [ClosureExpression](../../../../codehaus/groovy/ast/expr/closureexpression)` \| `[visitClosure](#visitClosure(org.apache.groovy.parser.antlr4.GroovyParser%24ClosureContext))(org.apache.groovy.parser.antlr4.GroovyParser$ClosureContext ctx)` \| \| \| `public [ClosureExpression](../../../../codehaus/groovy/ast/expr/closureexpression)` \| `[visitClosureOrLambdaExpression](#visitClosureOrLambdaExpression(org.apache.groovy.parser.antlr4.GroovyParser%24ClosureOrLambdaExpressionContext))(org.apache.groovy.parser.antlr4.GroovyParser$ClosureOrLambdaExpressionContext ctx)` \| \| \| `public [Expression](../../../../codehaus/groovy/ast/expr/expression)` \| `[visitCommandArgument](#visitCommandArgument(org.apache.groovy.parser.antlr4.GroovyParser%24CommandArgumentContext))(org.apache.groovy.parser.antlr4.GroovyParser$CommandArgumentContext ctx)` \| \| \| `public [ExpressionStatement](../../../../codehaus/groovy/ast/stmt/expressionstatement)` \| `[visitCommandExprAlt](#visitCommandExprAlt(org.apache.groovy.parser.antlr4.GroovyParser%24CommandExprAltContext))(org.apache.groovy.parser.antlr4.GroovyParser$CommandExprAltContext ctx)` \| \| \| `public [Expression](../../../../codehaus/groovy/ast/expr/expression)` \| `[visitCommandExpression](#visitCommandExpression(org.apache.groovy.parser.antlr4.GroovyParser%24CommandExpressionContext))(org.apache.groovy.parser.antlr4.GroovyParser$CommandExpressionContext ctx)` \| \| \| `public [MethodNode](../../../../codehaus/groovy/ast/methodnode)` \| `[visitCompactConstructorDeclaration](#visitCompactConstructorDeclaration(org.apache.groovy.parser.antlr4.GroovyParser%24CompactConstructorDeclarationContext))(org.apache.groovy.parser.antlr4.GroovyParser$CompactConstructorDeclarationContext ctx)` \| \| \| `public [ModuleNode](../../../../codehaus/groovy/ast/modulenode)` \| `[visitCompilationUnit](#visitCompilationUnit(org.apache.groovy.parser.antlr4.GroovyParser%24CompilationUnitContext))(org.apache.groovy.parser.antlr4.GroovyParser$CompilationUnitContext ctx)` \| \| \| `public [Expression](../../../../codehaus/groovy/ast/expr/expression)` \| `[visitConditionalExprAlt](#visitConditionalExprAlt(org.apache.groovy.parser.antlr4.GroovyParser%24ConditionalExprAltContext))(org.apache.groovy.parser.antlr4.GroovyParser$ConditionalExprAltContext ctx)` \| \| \| `public [Statement](../../../../codehaus/groovy/ast/stmt/statement)` \| `[visitConditionalStatement](#visitConditionalStatement(org.apache.groovy.parser.antlr4.GroovyParser%24ConditionalStatementContext))(org.apache.groovy.parser.antlr4.GroovyParser$ConditionalStatementContext ctx)` \| \| \| `public [ContinueStatement](../../../../codehaus/groovy/ast/stmt/continuestatement)` \| `[visitContinueStatement](#visitContinueStatement(org.apache.groovy.parser.antlr4.GroovyParser%24ContinueStatementContext))(org.apache.groovy.parser.antlr4.GroovyParser$ContinueStatementContext ctx)` \| \| \| `public [ClassNode](../../../../codehaus/groovy/ast/classnode)` \| `[visitCreatedName](#visitCreatedName(org.apache.groovy.parser.antlr4.GroovyParser%24CreatedNameContext))(org.apache.groovy.parser.antlr4.GroovyParser$CreatedNameContext ctx)` \| \| \| `public [Expression](../../../../codehaus/groovy/ast/expr/expression)` \| `[visitCreator](#visitCreator(org.apache.groovy.parser.antlr4.GroovyParser%24CreatorContext))(org.apache.groovy.parser.antlr4.GroovyParser$CreatorContext ctx)` \| \| \| `public [Tuple3](../../../../../groovy/lang/tuple3 "Tuple3")<[Expression](../../../../codehaus/groovy/ast/expr/expression "Expression"), [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[AnnotationNode](../../../../codehaus/groovy/ast/annotationnode "AnnotationNode")>, [TerminalNode](https://www.antlr.org/api/Java/org/antlr/v4/runtime/tree/TerminalNode.html "TerminalNode")>` \| `[visitDim](#visitDim(org.apache.groovy.parser.antlr4.GroovyParser%24DimContext))(org.apache.groovy.parser.antlr4.GroovyParser$DimContext ctx)` \| \| \| `public [DoWhileStatement](../../../../codehaus/groovy/ast/stmt/dowhilestatement)` \| `[visitDoWhileStmtAlt](#visitDoWhileStmtAlt(org.apache.groovy.parser.antlr4.GroovyParser%24DoWhileStmtAltContext))(org.apache.groovy.parser.antlr4.GroovyParser$DoWhileStmtAltContext ctx)` \| \| \| `public [Expression](../../../../codehaus/groovy/ast/expr/expression)` \| `[visitDynamicMemberName](#visitDynamicMemberName(org.apache.groovy.parser.antlr4.GroovyParser%24DynamicMemberNameContext))(org.apache.groovy.parser.antlr4.GroovyParser$DynamicMemberNameContext ctx)` \| \| \| `public [Expression](../../../../codehaus/groovy/ast/expr/expression)` \| `[visitElementValue](#visitElementValue(org.apache.groovy.parser.antlr4.GroovyParser%24ElementValueContext))(org.apache.groovy.parser.antlr4.GroovyParser$ElementValueContext ctx)` \| \| \| `public [ListExpression](../../../../codehaus/groovy/ast/expr/listexpression)` \| `[visitElementValueArrayInitializer](#visitElementValueArrayInitializer(org.apache.groovy.parser.antlr4.GroovyParser%24ElementValueArrayInitializerContext))(org.apache.groovy.parser.antlr4.GroovyParser$ElementValueArrayInitializerContext ctx)` \| \| \| `public [Tuple2](../../../../../groovy/lang/tuple2 "Tuple2")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Expression](../../../../codehaus/groovy/ast/expr/expression "Expression")>` \| `[visitElementValuePair](#visitElementValuePair(org.apache.groovy.parser.antlr4.GroovyParser%24ElementValuePairContext))(org.apache.groovy.parser.antlr4.GroovyParser$ElementValuePairContext ctx)` \| \| \| `public [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Expression](../../../../codehaus/groovy/ast/expr/expression "Expression")>` \| `[visitElementValuePairs](#visitElementValuePairs(org.apache.groovy.parser.antlr4.GroovyParser%24ElementValuePairsContext))(org.apache.groovy.parser.antlr4.GroovyParser$ElementValuePairsContext ctx)` \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Tuple2](../../../../../groovy/lang/tuple2 "Tuple2")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Expression](../../../../codehaus/groovy/ast/expr/expression "Expression")>>` \| `[visitElementValues](#visitElementValues(org.apache.groovy.parser.antlr4.GroovyParser%24ElementValuesContext))(org.apache.groovy.parser.antlr4.GroovyParser$ElementValuesContext ctx)` \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[AnnotationNode](../../../../codehaus/groovy/ast/annotationnode "AnnotationNode")>>` \| `[visitEmptyDims](#visitEmptyDims(org.apache.groovy.parser.antlr4.GroovyParser%24EmptyDimsContext))(org.apache.groovy.parser.antlr4.GroovyParser$EmptyDimsContext ctx)` \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[AnnotationNode](../../../../codehaus/groovy/ast/annotationnode "AnnotationNode")>>` \| `[visitEmptyDimsOpt](#visitEmptyDimsOpt(org.apache.groovy.parser.antlr4.GroovyParser%24EmptyDimsOptContext))(org.apache.groovy.parser.antlr4.GroovyParser$EmptyDimsOptContext ctx)` \| \| \| `public [Expression](../../../../codehaus/groovy/ast/expr/expression)` \| `[visitEnhancedArgumentListElement](#visitEnhancedArgumentListElement(org.apache.groovy.parser.antlr4.GroovyParser%24EnhancedArgumentListElementContext))(org.apache.groovy.parser.antlr4.GroovyParser$EnhancedArgumentListElementContext ctx)` \| \| \| `public [Expression](../../../../codehaus/groovy/ast/expr/expression)` \| `[visitEnhancedArgumentListInPar](#visitEnhancedArgumentListInPar(org.apache.groovy.parser.antlr4.GroovyParser%24EnhancedArgumentListInParContext))(org.apache.groovy.parser.antlr4.GroovyParser$EnhancedArgumentListInParContext ctx)` \| \| \| `public [Tuple2](../../../../../groovy/lang/tuple2 "Tuple2")<[Parameter](../../../../codehaus/groovy/ast/parameter "Parameter"), [Expression](../../../../codehaus/groovy/ast/expr/expression "Expression")>` \| `[visitEnhancedForControl](#visitEnhancedForControl(org.apache.groovy.parser.antlr4.GroovyParser%24EnhancedForControlContext))(org.apache.groovy.parser.antlr4.GroovyParser$EnhancedForControlContext ctx)` \| \| \| `public [Expression](../../../../codehaus/groovy/ast/expr/expression)` \| `[visitEnhancedStatementExpression](#visitEnhancedStatementExpression(org.apache.groovy.parser.antlr4.GroovyParser%24EnhancedStatementExpressionContext))(org.apache.groovy.parser.antlr4.GroovyParser$EnhancedStatementExpressionContext ctx)` \| \| \| `public [FieldNode](../../../../codehaus/groovy/ast/fieldnode)` \| `[visitEnumConstant](#visitEnumConstant(org.apache.groovy.parser.antlr4.GroovyParser%24EnumConstantContext))(org.apache.groovy.parser.antlr4.GroovyParser$EnumConstantContext ctx)` \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[FieldNode](../../../../codehaus/groovy/ast/fieldnode "FieldNode")>` \| `[visitEnumConstants](#visitEnumConstants(org.apache.groovy.parser.antlr4.GroovyParser%24EnumConstantsContext))(org.apache.groovy.parser.antlr4.GroovyParser$EnumConstantsContext ctx)` \| \| \| `public [BinaryExpression](../../../../codehaus/groovy/ast/expr/binaryexpression)` \| `[visitEqualityExprAlt](#visitEqualityExprAlt(org.apache.groovy.parser.antlr4.GroovyParser%24EqualityExprAltContext))(org.apache.groovy.parser.antlr4.GroovyParser$EqualityExprAltContext ctx)` \| \| \| `public [BinaryExpression](../../../../codehaus/groovy/ast/expr/binaryexpression)` \| `[visitExclusiveOrExprAlt](#visitExclusiveOrExprAlt(org.apache.groovy.parser.antlr4.GroovyParser%24ExclusiveOrExprAltContext))(org.apache.groovy.parser.antlr4.GroovyParser$ExclusiveOrExprAltContext ctx)` \| \| \| `public [Expression](../../../../codehaus/groovy/ast/expr/expression)` \| `[visitExpressionInPar](#visitExpressionInPar(org.apache.groovy.parser.antlr4.GroovyParser%24ExpressionInParContext))(org.apache.groovy.parser.antlr4.GroovyParser$ExpressionInParContext ctx)` \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Expression](../../../../codehaus/groovy/ast/expr/expression "Expression")>` \| `[visitExpressionList](#visitExpressionList(org.apache.groovy.parser.antlr4.GroovyParser%24ExpressionListContext))(org.apache.groovy.parser.antlr4.GroovyParser$ExpressionListContext ctx)` \| \| \| `public [Expression](../../../../codehaus/groovy/ast/expr/expression)` \| `[visitExpressionListElement](#visitExpressionListElement(org.apache.groovy.parser.antlr4.GroovyParser%24ExpressionListElementContext))(org.apache.groovy.parser.antlr4.GroovyParser$ExpressionListElementContext ctx)` \| \| \| `public [Void](https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html "Void")` \| `[visitFieldDeclaration](#visitFieldDeclaration(org.apache.groovy.parser.antlr4.GroovyParser%24FieldDeclarationContext))(org.apache.groovy.parser.antlr4.GroovyParser$FieldDeclarationContext ctx)` \| \| \| `public [Statement](../../../../codehaus/groovy/ast/stmt/statement)` \| `[visitFinallyBlock](#visitFinallyBlock(org.apache.groovy.parser.antlr4.GroovyParser%24FinallyBlockContext))(org.apache.groovy.parser.antlr4.GroovyParser$FinallyBlockContext ctx)` \| \| \| `public [ConstantExpression](../../../../codehaus/groovy/ast/expr/constantexpression)` \| `[visitFloatingPointLiteralAlt](#visitFloatingPointLiteralAlt(org.apache.groovy.parser.antlr4.GroovyParser%24FloatingPointLiteralAltContext))(org.apache.groovy.parser.antlr4.GroovyParser$FloatingPointLiteralAltContext ctx)` \| \| \| `public [Tuple2](../../../../../groovy/lang/tuple2 "Tuple2")<[Parameter](../../../../codehaus/groovy/ast/parameter "Parameter"), [Expression](../../../../codehaus/groovy/ast/expr/expression "Expression")>` \| `[visitForControl](#visitForControl(org.apache.groovy.parser.antlr4.GroovyParser%24ForControlContext))(org.apache.groovy.parser.antlr4.GroovyParser$ForControlContext ctx)` \| \| \| `public [Expression](../../../../codehaus/groovy/ast/expr/expression)` \| `[visitForInit](#visitForInit(org.apache.groovy.parser.antlr4.GroovyParser%24ForInitContext))(org.apache.groovy.parser.antlr4.GroovyParser$ForInitContext ctx)` \| \| \| `public [ForStatement](../../../../codehaus/groovy/ast/stmt/forstatement)` \| `[visitForStmtAlt](#visitForStmtAlt(org.apache.groovy.parser.antlr4.GroovyParser%24ForStmtAltContext))(org.apache.groovy.parser.antlr4.GroovyParser$ForStmtAltContext ctx)` \| \| \| `public [Expression](../../../../codehaus/groovy/ast/expr/expression)` \| `[visitForUpdate](#visitForUpdate(org.apache.groovy.parser.antlr4.GroovyParser%24ForUpdateContext))(org.apache.groovy.parser.antlr4.GroovyParser$ForUpdateContext ctx)` \| \| \| `public [Parameter](../../../../codehaus/groovy/ast/parameter)` \| `[visitFormalParameter](#visitFormalParameter(org.apache.groovy.parser.antlr4.GroovyParser%24FormalParameterContext))(org.apache.groovy.parser.antlr4.GroovyParser$FormalParameterContext ctx)` \| \| \| `public [Parameter](../../../../codehaus/groovy/ast/parameter)[]` \| `[visitFormalParameterList](#visitFormalParameterList(org.apache.groovy.parser.antlr4.GroovyParser%24FormalParameterListContext))(org.apache.groovy.parser.antlr4.GroovyParser$FormalParameterListContext ctx)` \| \| \| `public [Parameter](../../../../codehaus/groovy/ast/parameter)[]` \| `[visitFormalParameters](#visitFormalParameters(org.apache.groovy.parser.antlr4.GroovyParser%24FormalParametersContext))(org.apache.groovy.parser.antlr4.GroovyParser$FormalParametersContext ctx)` \| \| \| `public [GStringExpression](../../../../codehaus/groovy/ast/expr/gstringexpression)` \| `[visitGstring](#visitGstring(org.apache.groovy.parser.antlr4.GroovyParser%24GstringContext))(org.apache.groovy.parser.antlr4.GroovyParser$GstringContext ctx)` \| \| \| `public [Expression](../../../../codehaus/groovy/ast/expr/expression)` \| `[visitGstringPath](#visitGstringPath(org.apache.groovy.parser.antlr4.GroovyParser%24GstringPathContext))(org.apache.groovy.parser.antlr4.GroovyParser$GstringPathContext ctx)` \| \| \| `public [Expression](../../../../codehaus/groovy/ast/expr/expression)` \| `[visitGstringValue](#visitGstringValue(org.apache.groovy.parser.antlr4.GroovyParser%24GstringValueContext))(org.apache.groovy.parser.antlr4.GroovyParser$GstringValueContext ctx)` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[visitIdentifier](#visitIdentifier(org.apache.groovy.parser.antlr4.GroovyParser%24IdentifierContext))(org.apache.groovy.parser.antlr4.GroovyParser$IdentifierContext ctx)` \| \| \| `public [Expression](../../../../codehaus/groovy/ast/expr/expression)` \| `[visitIdentifierPrmrAlt](#visitIdentifierPrmrAlt(org.apache.groovy.parser.antlr4.GroovyParser%24IdentifierPrmrAltContext))(org.apache.groovy.parser.antlr4.GroovyParser$IdentifierPrmrAltContext ctx)` \| \| \| `public [IfStatement](../../../../codehaus/groovy/ast/stmt/ifstatement)` \| `[visitIfElseStatement](#visitIfElseStatement(org.apache.groovy.parser.antlr4.GroovyParser%24IfElseStatementContext))(org.apache.groovy.parser.antlr4.GroovyParser$IfElseStatementContext ctx)` \| \| \| `public [ImportNode](../../../../codehaus/groovy/ast/importnode)` \| `[visitImportDeclaration](#visitImportDeclaration(org.apache.groovy.parser.antlr4.GroovyParser%24ImportDeclarationContext))(org.apache.groovy.parser.antlr4.GroovyParser$ImportDeclarationContext ctx)` \| \| \| `public [BinaryExpression](../../../../codehaus/groovy/ast/expr/binaryexpression)` \| `[visitInclusiveOrExprAlt](#visitInclusiveOrExprAlt(org.apache.groovy.parser.antlr4.GroovyParser%24InclusiveOrExprAltContext))(org.apache.groovy.parser.antlr4.GroovyParser$InclusiveOrExprAltContext ctx)` \| \| \| `public [Tuple2](../../../../../groovy/lang/tuple2 "Tuple2")<[Token](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Token.html "Token"), [Expression](../../../../codehaus/groovy/ast/expr/expression "Expression")>` \| `[visitIndexPropertyArgs](#visitIndexPropertyArgs(org.apache.groovy.parser.antlr4.GroovyParser%24IndexPropertyArgsContext))(org.apache.groovy.parser.antlr4.GroovyParser$IndexPropertyArgsContext ctx)` \| \| \| `public [ConstantExpression](../../../../codehaus/groovy/ast/expr/constantexpression)` \| `[visitIntegerLiteralAlt](#visitIntegerLiteralAlt(org.apache.groovy.parser.antlr4.GroovyParser%24IntegerLiteralAltContext))(org.apache.groovy.parser.antlr4.GroovyParser$IntegerLiteralAltContext ctx)` \| \| \| `public [ConstantExpression](../../../../codehaus/groovy/ast/expr/constantexpression)` \| `[visitKeywords](#visitKeywords(org.apache.groovy.parser.antlr4.GroovyParser%24KeywordsContext))(org.apache.groovy.parser.antlr4.GroovyParser$KeywordsContext ctx)` \| \| \| `public [Statement](../../../../codehaus/groovy/ast/stmt/statement)` \| `[visitLabeledStmtAlt](#visitLabeledStmtAlt(org.apache.groovy.parser.antlr4.GroovyParser%24LabeledStmtAltContext))(org.apache.groovy.parser.antlr4.GroovyParser$LabeledStmtAltContext ctx)` \| \| \| `public [Statement](../../../../codehaus/groovy/ast/stmt/statement)` \| `[visitLambdaBody](#visitLambdaBody(org.apache.groovy.parser.antlr4.GroovyParser%24LambdaBodyContext))(org.apache.groovy.parser.antlr4.GroovyParser$LambdaBodyContext ctx)` \| \| \| `public [ListExpression](../../../../codehaus/groovy/ast/expr/listexpression)` \| `[visitList](#visitList(org.apache.groovy.parser.antlr4.GroovyParser%24ListContext))(org.apache.groovy.parser.antlr4.GroovyParser$ListContext ctx)` \| \| \| `public [AstBuilder.DeclarationListStatement](astbuilder.declarationliststatement)` \| `[visitLocalVariableDeclaration](#visitLocalVariableDeclaration(org.apache.groovy.parser.antlr4.GroovyParser%24LocalVariableDeclarationContext))(org.apache.groovy.parser.antlr4.GroovyParser$LocalVariableDeclarationContext ctx)` \| \| \| `public [BinaryExpression](../../../../codehaus/groovy/ast/expr/binaryexpression)` \| `[visitLogicalAndExprAlt](#visitLogicalAndExprAlt(org.apache.groovy.parser.antlr4.GroovyParser%24LogicalAndExprAltContext))(org.apache.groovy.parser.antlr4.GroovyParser$LogicalAndExprAltContext ctx)` \| \| \| `public [BinaryExpression](../../../../codehaus/groovy/ast/expr/binaryexpression)` \| `[visitLogicalOrExprAlt](#visitLogicalOrExprAlt(org.apache.groovy.parser.antlr4.GroovyParser%24LogicalOrExprAltContext))(org.apache.groovy.parser.antlr4.GroovyParser$LogicalOrExprAltContext ctx)` \| \| \| `public [Statement](../../../../codehaus/groovy/ast/stmt/statement)` \| `[visitLoopStmtAlt](#visitLoopStmtAlt(org.apache.groovy.parser.antlr4.GroovyParser%24LoopStmtAltContext))(org.apache.groovy.parser.antlr4.GroovyParser$LoopStmtAltContext ctx)` \| \| \| `public [MapExpression](../../../../codehaus/groovy/ast/expr/mapexpression)` \| `[visitMap](#visitMap(org.apache.groovy.parser.antlr4.GroovyParser%24MapContext))(org.apache.groovy.parser.antlr4.GroovyParser$MapContext ctx)` \| \| \| `public [MapEntryExpression](../../../../codehaus/groovy/ast/expr/mapentryexpression)` \| `[visitMapEntry](#visitMapEntry(org.apache.groovy.parser.antlr4.GroovyParser%24MapEntryContext))(org.apache.groovy.parser.antlr4.GroovyParser$MapEntryContext ctx)` \| \| \| `public [Expression](../../../../codehaus/groovy/ast/expr/expression)` \| `[visitMapEntryLabel](#visitMapEntryLabel(org.apache.groovy.parser.antlr4.GroovyParser%24MapEntryLabelContext))(org.apache.groovy.parser.antlr4.GroovyParser$MapEntryLabelContext ctx)` \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[MapEntryExpression](../../../../codehaus/groovy/ast/expr/mapentryexpression "MapEntryExpression")>` \| `[visitMapEntryList](#visitMapEntryList(org.apache.groovy.parser.antlr4.GroovyParser%24MapEntryListContext))(org.apache.groovy.parser.antlr4.GroovyParser$MapEntryListContext ctx)` \| \| \| `public [Void](https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html "Void")` \| `[visitMemberDeclaration](#visitMemberDeclaration(org.apache.groovy.parser.antlr4.GroovyParser%24MemberDeclarationContext))(org.apache.groovy.parser.antlr4.GroovyParser$MemberDeclarationContext ctx)` \| \| \| `public [Statement](../../../../codehaus/groovy/ast/stmt/statement)` \| `[visitMethodBody](#visitMethodBody(org.apache.groovy.parser.antlr4.GroovyParser%24MethodBodyContext))(org.apache.groovy.parser.antlr4.GroovyParser$MethodBodyContext ctx)` \| \| \| `public [MethodNode](../../../../codehaus/groovy/ast/methodnode)` \| `[visitMethodDeclaration](#visitMethodDeclaration(org.apache.groovy.parser.antlr4.GroovyParser%24MethodDeclarationContext))(org.apache.groovy.parser.antlr4.GroovyParser$MethodDeclarationContext ctx)` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[visitMethodName](#visitMethodName(org.apache.groovy.parser.antlr4.GroovyParser%24MethodNameContext))(org.apache.groovy.parser.antlr4.GroovyParser$MethodNameContext ctx)` \| \| \| `public [ModifierNode](../../../../codehaus/groovy/ast/modifiernode)` \| `[visitModifier](#visitModifier(org.apache.groovy.parser.antlr4.GroovyParser%24ModifierContext))(org.apache.groovy.parser.antlr4.GroovyParser$ModifierContext ctx)` \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[ModifierNode](../../../../codehaus/groovy/ast/modifiernode "ModifierNode")>` \| `[visitModifiers](#visitModifiers(org.apache.groovy.parser.antlr4.GroovyParser%24ModifiersContext))(org.apache.groovy.parser.antlr4.GroovyParser$ModifiersContext ctx)` \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[ModifierNode](../../../../codehaus/groovy/ast/modifiernode "ModifierNode")>` \| `[visitModifiersOpt](#visitModifiersOpt(org.apache.groovy.parser.antlr4.GroovyParser%24ModifiersOptContext))(org.apache.groovy.parser.antlr4.GroovyParser$ModifiersOptContext ctx)` \| \| \| `public [BinaryExpression](../../../../codehaus/groovy/ast/expr/binaryexpression)` \| `[visitMultipleAssignmentExprAlt](#visitMultipleAssignmentExprAlt(org.apache.groovy.parser.antlr4.GroovyParser%24MultipleAssignmentExprAltContext))(org.apache.groovy.parser.antlr4.GroovyParser$MultipleAssignmentExprAltContext ctx)` \| \| \| `public [BinaryExpression](../../../../codehaus/groovy/ast/expr/binaryexpression)` \| `[visitMultiplicativeExprAlt](#visitMultiplicativeExprAlt(org.apache.groovy.parser.antlr4.GroovyParser%24MultiplicativeExprAltContext))(org.apache.groovy.parser.antlr4.GroovyParser$MultiplicativeExprAltContext ctx)` \| \| \| `public [Expression](../../../../codehaus/groovy/ast/expr/expression)` \| `[visitNamePart](#visitNamePart(org.apache.groovy.parser.antlr4.GroovyParser%24NamePartContext))(org.apache.groovy.parser.antlr4.GroovyParser$NamePartContext ctx)` \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[MapEntryExpression](../../../../codehaus/groovy/ast/expr/mapentryexpression "MapEntryExpression")>` \| `[visitNamedPropertyArgs](#visitNamedPropertyArgs(org.apache.groovy.parser.antlr4.GroovyParser%24NamedPropertyArgsContext))(org.apache.groovy.parser.antlr4.GroovyParser$NamedPropertyArgsContext ctx)` \| \| \| `public [Expression](../../../../codehaus/groovy/ast/expr/expression)` \| `[visitNewPrmrAlt](#visitNewPrmrAlt(org.apache.groovy.parser.antlr4.GroovyParser%24NewPrmrAltContext))(org.apache.groovy.parser.antlr4.GroovyParser$NewPrmrAltContext ctx)` \| \| \| `public [GenericsType](../../../../codehaus/groovy/ast/genericstype)[]` \| `[visitNonWildcardTypeArguments](#visitNonWildcardTypeArguments(org.apache.groovy.parser.antlr4.GroovyParser%24NonWildcardTypeArgumentsContext))(org.apache.groovy.parser.antlr4.GroovyParser$NonWildcardTypeArgumentsContext ctx)` \| \| \| `public [ConstantExpression](../../../../codehaus/groovy/ast/expr/constantexpression)` \| `[visitNullLiteralAlt](#visitNullLiteralAlt(org.apache.groovy.parser.antlr4.GroovyParser%24NullLiteralAltContext))(org.apache.groovy.parser.antlr4.GroovyParser$NullLiteralAltContext ctx)` \| \| \| `public [PackageNode](../../../../codehaus/groovy/ast/packagenode)` \| `[visitPackageDeclaration](#visitPackageDeclaration(org.apache.groovy.parser.antlr4.GroovyParser%24PackageDeclarationContext))(org.apache.groovy.parser.antlr4.GroovyParser$PackageDeclarationContext ctx)` \| \| \| `public [Expression](../../../../codehaus/groovy/ast/expr/expression)` \| `[visitParExpression](#visitParExpression(org.apache.groovy.parser.antlr4.GroovyParser%24ParExpressionContext))(org.apache.groovy.parser.antlr4.GroovyParser$ParExpressionContext ctx)` \| \| \| `public [Expression](../../../../codehaus/groovy/ast/expr/expression)` \| `[visitPathElement](#visitPathElement(org.apache.groovy.parser.antlr4.GroovyParser%24PathElementContext))(org.apache.groovy.parser.antlr4.GroovyParser$PathElementContext ctx)` \| \| \| `public [Expression](../../../../codehaus/groovy/ast/expr/expression)` \| `[visitPathExpression](#visitPathExpression(org.apache.groovy.parser.antlr4.GroovyParser%24PathExpressionContext))(org.apache.groovy.parser.antlr4.GroovyParser$PathExpressionContext ctx)` \| \| \| `public [Expression](../../../../codehaus/groovy/ast/expr/expression)` \| `[visitPostfixExpression](#visitPostfixExpression(org.apache.groovy.parser.antlr4.GroovyParser%24PostfixExpressionContext))(org.apache.groovy.parser.antlr4.GroovyParser$PostfixExpressionContext ctx)` \| \| \| `public [BinaryExpression](../../../../codehaus/groovy/ast/expr/binaryexpression)` \| `[visitPowerExprAlt](#visitPowerExprAlt(org.apache.groovy.parser.antlr4.GroovyParser%24PowerExprAltContext))(org.apache.groovy.parser.antlr4.GroovyParser$PowerExprAltContext ctx)` \| \| \| `public [ClassNode](../../../../codehaus/groovy/ast/classnode)` \| `[visitPrimitiveType](#visitPrimitiveType(org.apache.groovy.parser.antlr4.GroovyParser%24PrimitiveTypeContext))(org.apache.groovy.parser.antlr4.GroovyParser$PrimitiveTypeContext ctx)` \| \| \| `public void` \| `[visitPropertyExpression](#visitPropertyExpression(org.codehaus.groovy.ast.expr.PropertyExpression))([PropertyExpression](../../../../codehaus/groovy/ast/expr/propertyexpression) expression)` \| \| \| `public [ClassNode](../../../../codehaus/groovy/ast/classnode)` \| `[visitQualifiedClassName](#visitQualifiedClassName(org.apache.groovy.parser.antlr4.GroovyParser%24QualifiedClassNameContext))(org.apache.groovy.parser.antlr4.GroovyParser$QualifiedClassNameContext ctx)` \| \| \| `public [ClassNode](../../../../codehaus/groovy/ast/classnode)[]` \| `[visitQualifiedClassNameList](#visitQualifiedClassNameList(org.apache.groovy.parser.antlr4.GroovyParser%24QualifiedClassNameListContext))(org.apache.groovy.parser.antlr4.GroovyParser$QualifiedClassNameListContext ctx)` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[visitQualifiedName](#visitQualifiedName(org.apache.groovy.parser.antlr4.GroovyParser%24QualifiedNameContext))(org.apache.groovy.parser.antlr4.GroovyParser$QualifiedNameContext ctx)` \| \| \| `public [ClassNode](../../../../codehaus/groovy/ast/classnode)` \| `[visitQualifiedStandardClassName](#visitQualifiedStandardClassName(org.apache.groovy.parser.antlr4.GroovyParser%24QualifiedStandardClassNameContext))(org.apache.groovy.parser.antlr4.GroovyParser$QualifiedStandardClassNameContext ctx)` \| \| \| `public [BinaryExpression](../../../../codehaus/groovy/ast/expr/binaryexpression)` \| `[visitRegexExprAlt](#visitRegexExprAlt(org.apache.groovy.parser.antlr4.GroovyParser%24RegexExprAltContext))(org.apache.groovy.parser.antlr4.GroovyParser$RegexExprAltContext ctx)` \| \| \| `public [Expression](../../../../codehaus/groovy/ast/expr/expression)` \| `[visitRelationalExprAlt](#visitRelationalExprAlt(org.apache.groovy.parser.antlr4.GroovyParser%24RelationalExprAltContext))(org.apache.groovy.parser.antlr4.GroovyParser$RelationalExprAltContext ctx)` \| \| \| `public [ExpressionStatement](../../../../codehaus/groovy/ast/stmt/expressionstatement)` \| `[visitResource](#visitResource(org.apache.groovy.parser.antlr4.GroovyParser%24ResourceContext))(org.apache.groovy.parser.antlr4.GroovyParser$ResourceContext ctx)` \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[ExpressionStatement](../../../../codehaus/groovy/ast/stmt/expressionstatement "ExpressionStatement")>` \| `[visitResourceList](#visitResourceList(org.apache.groovy.parser.antlr4.GroovyParser%24ResourceListContext))(org.apache.groovy.parser.antlr4.GroovyParser$ResourceListContext ctx)` \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[ExpressionStatement](../../../../codehaus/groovy/ast/stmt/expressionstatement "ExpressionStatement")>` \| `[visitResources](#visitResources(org.apache.groovy.parser.antlr4.GroovyParser%24ResourcesContext))(org.apache.groovy.parser.antlr4.GroovyParser$ResourcesContext ctx)` \| \| \| `public void` \| `[visitReturnStatement](#visitReturnStatement(org.codehaus.groovy.ast.stmt.ReturnStatement))([ReturnStatement](../../../../codehaus/groovy/ast/stmt/returnstatement) statement)` \| \| \| `public [ReturnStatement](../../../../codehaus/groovy/ast/stmt/returnstatement)` \| `[visitReturnStmtAlt](#visitReturnStmtAlt(org.apache.groovy.parser.antlr4.GroovyParser%24ReturnStmtAltContext))(org.apache.groovy.parser.antlr4.GroovyParser$ReturnStmtAltContext ctx)` \| \| \| `public [ClassNode](../../../../codehaus/groovy/ast/classnode)` \| `[visitReturnType](#visitReturnType(org.apache.groovy.parser.antlr4.GroovyParser%24ReturnTypeContext))(org.apache.groovy.parser.antlr4.GroovyParser$ReturnTypeContext ctx)` \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[ASTNode](../../../../codehaus/groovy/ast/astnode "ASTNode")>` \| `[visitScriptStatements](#visitScriptStatements(org.apache.groovy.parser.antlr4.GroovyParser%24ScriptStatementsContext))(org.apache.groovy.parser.antlr4.GroovyParser$ScriptStatementsContext ctx)` \| \| \| `public [Expression](../../../../codehaus/groovy/ast/expr/expression)` \| `[visitShiftExprAlt](#visitShiftExprAlt(org.apache.groovy.parser.antlr4.GroovyParser%24ShiftExprAltContext))(org.apache.groovy.parser.antlr4.GroovyParser$ShiftExprAltContext ctx)` \| \| \| `public [LambdaExpression](../../../../codehaus/groovy/ast/expr/lambdaexpression)` \| `[visitStandardLambdaExpression](#visitStandardLambdaExpression(org.apache.groovy.parser.antlr4.GroovyParser%24StandardLambdaExpressionContext))(org.apache.groovy.parser.antlr4.GroovyParser$StandardLambdaExpressionContext ctx)` \| \| \| `public [Parameter](../../../../codehaus/groovy/ast/parameter)[]` \| `[visitStandardLambdaParameters](#visitStandardLambdaParameters(org.apache.groovy.parser.antlr4.GroovyParser%24StandardLambdaParametersContext))(org.apache.groovy.parser.antlr4.GroovyParser$StandardLambdaParametersContext ctx)` \| \| \| `public [ConstantExpression](../../../../codehaus/groovy/ast/expr/constantexpression)` \| `[visitStringLiteral](#visitStringLiteral(org.apache.groovy.parser.antlr4.GroovyParser%24StringLiteralContext))(org.apache.groovy.parser.antlr4.GroovyParser$StringLiteralContext ctx)` \| \| \| `public [VariableExpression](../../../../codehaus/groovy/ast/expr/variableexpression)` \| `[visitSuperPrmrAlt](#visitSuperPrmrAlt(org.apache.groovy.parser.antlr4.GroovyParser%24SuperPrmrAltContext))(org.apache.groovy.parser.antlr4.GroovyParser$SuperPrmrAltContext ctx)` \| \| \| `public [Tuple3](../../../../../groovy/lang/tuple3 "Tuple3")<[List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Statement](../../../../codehaus/groovy/ast/stmt/statement "Statement")>, [Boolean](https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html "Boolean"), [Boolean](https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html "Boolean")>` \| `[visitSwitchBlockStatementExpressionGroup](#visitSwitchBlockStatementExpressionGroup(org.apache.groovy.parser.antlr4.GroovyLangParser.SwitchBlockStatementExpressionGroupContext))([SwitchBlockStatementExpressionGroupContext](groovylangparser.switchblockstatementexpressiongroupcontext) ctx)` \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Statement](../../../../codehaus/groovy/ast/stmt/statement "Statement")>` \| `[visitSwitchBlockStatementGroup](#visitSwitchBlockStatementGroup(org.apache.groovy.parser.antlr4.GroovyParser%24SwitchBlockStatementGroupContext))(org.apache.groovy.parser.antlr4.GroovyParser$SwitchBlockStatementGroupContext ctx)` \| \| \| `public [Expression](../../../../codehaus/groovy/ast/expr/expression)` \| `[visitSwitchExprAlt](#visitSwitchExprAlt(org.apache.groovy.parser.antlr4.GroovyLangParser.SwitchExprAltContext))([SwitchExprAltContext](groovylangparser.switchexpraltcontext) ctx)` \| \| \| `public [MethodCallExpression](../../../../codehaus/groovy/ast/expr/methodcallexpression)` \| `[visitSwitchExpression](#visitSwitchExpression(org.apache.groovy.parser.antlr4.GroovyLangParser.SwitchExpressionContext))([SwitchExpressionContext](groovylangparser.switchexpressioncontext) ctx)` ``` switch(a) { case 0, 1 -> 'a'; case 2 -> 'b'; default -> 'z'; } ``` the above code will be transformed to: ``` {-> switch(a) { case 0: case 1: return 'a'; case 2: return 'b'; default: return 'z'; } }() ``` \| \| \| `public [Tuple3](../../../../../groovy/lang/tuple3 "Tuple3")<[Token](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Token.html "Token"), [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Expression](../../../../codehaus/groovy/ast/expr/expression "Expression")>, [Integer](https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html "Integer")>` \| `[visitSwitchExpressionLabel](#visitSwitchExpressionLabel(org.apache.groovy.parser.antlr4.GroovyLangParser.SwitchExpressionLabelContext))([SwitchExpressionLabelContext](groovylangparser.switchexpressionlabelcontext) ctx)` \| \| \| `public [Tuple2](../../../../../groovy/lang/tuple2 "Tuple2")<[Token](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Token.html "Token"), [Expression](../../../../codehaus/groovy/ast/expr/expression "Expression")>` \| `[visitSwitchLabel](#visitSwitchLabel(org.apache.groovy.parser.antlr4.GroovyParser%24SwitchLabelContext))(org.apache.groovy.parser.antlr4.GroovyParser$SwitchLabelContext ctx)` \| \| \| `public [SwitchStatement](../../../../codehaus/groovy/ast/stmt/switchstatement)` \| `[visitSwitchStatement](#visitSwitchStatement(org.apache.groovy.parser.antlr4.GroovyParser%24SwitchStatementContext))(org.apache.groovy.parser.antlr4.GroovyParser$SwitchStatementContext ctx)` \| \| \| `public [SynchronizedStatement](../../../../codehaus/groovy/ast/stmt/synchronizedstatement)` \| `[visitSynchronizedStmtAlt](#visitSynchronizedStmtAlt(org.apache.groovy.parser.antlr4.GroovyParser%24SynchronizedStmtAltContext))(org.apache.groovy.parser.antlr4.GroovyParser$SynchronizedStmtAltContext ctx)` \| \| \| `public [Parameter](../../../../codehaus/groovy/ast/parameter)` \| `[visitThisFormalParameter](#visitThisFormalParameter(org.apache.groovy.parser.antlr4.GroovyParser%24ThisFormalParameterContext))(org.apache.groovy.parser.antlr4.GroovyParser$ThisFormalParameterContext ctx)` \| \| \| `public [VariableExpression](../../../../codehaus/groovy/ast/expr/variableexpression)` \| `[visitThisPrmrAlt](#visitThisPrmrAlt(org.apache.groovy.parser.antlr4.GroovyParser%24ThisPrmrAltContext))(org.apache.groovy.parser.antlr4.GroovyParser$ThisPrmrAltContext ctx)` \| \| \| `public void` \| `[visitThrowStatement](#visitThrowStatement(org.codehaus.groovy.ast.stmt.ThrowStatement))([ThrowStatement](../../../../codehaus/groovy/ast/stmt/throwstatement) statement)` \| \| \| `public [ThrowStatement](../../../../codehaus/groovy/ast/stmt/throwstatement)` \| `[visitThrowStmtAlt](#visitThrowStmtAlt(org.apache.groovy.parser.antlr4.GroovyParser%24ThrowStmtAltContext))(org.apache.groovy.parser.antlr4.GroovyParser$ThrowStmtAltContext ctx)` \| \| \| `public [Statement](../../../../codehaus/groovy/ast/stmt/statement)` \| `[visitTryCatchStatement](#visitTryCatchStatement(org.apache.groovy.parser.antlr4.GroovyParser%24TryCatchStatementContext))(org.apache.groovy.parser.antlr4.GroovyParser$TryCatchStatementContext ctx)` \| \| \| `public [ClassNode](../../../../codehaus/groovy/ast/classnode)` \| `[visitType](#visitType(org.apache.groovy.parser.antlr4.GroovyParser%24TypeContext))(org.apache.groovy.parser.antlr4.GroovyParser$TypeContext ctx)` \| \| \| `public [GenericsType](../../../../codehaus/groovy/ast/genericstype)` \| `[visitTypeArgument](#visitTypeArgument(org.apache.groovy.parser.antlr4.GroovyParser%24TypeArgumentContext))(org.apache.groovy.parser.antlr4.GroovyParser$TypeArgumentContext ctx)` \| \| \| `public [GenericsType](../../../../codehaus/groovy/ast/genericstype)[]` \| `[visitTypeArguments](#visitTypeArguments(org.apache.groovy.parser.antlr4.GroovyParser%24TypeArgumentsContext))(org.apache.groovy.parser.antlr4.GroovyParser$TypeArgumentsContext ctx)` \| \| \| `public [GenericsType](../../../../codehaus/groovy/ast/genericstype)[]` \| `[visitTypeArgumentsOrDiamond](#visitTypeArgumentsOrDiamond(org.apache.groovy.parser.antlr4.GroovyParser%24TypeArgumentsOrDiamondContext))(org.apache.groovy.parser.antlr4.GroovyParser$TypeArgumentsOrDiamondContext ctx)` \| \| \| `public [ClassNode](../../../../codehaus/groovy/ast/classnode)[]` \| `[visitTypeBound](#visitTypeBound(org.apache.groovy.parser.antlr4.GroovyParser%24TypeBoundContext))(org.apache.groovy.parser.antlr4.GroovyParser$TypeBoundContext ctx)` \| \| \| `public [ClassNode](../../../../codehaus/groovy/ast/classnode)` \| `[visitTypeDeclaration](#visitTypeDeclaration(org.apache.groovy.parser.antlr4.GroovyParser%24TypeDeclarationContext))(org.apache.groovy.parser.antlr4.GroovyParser$TypeDeclarationContext ctx)` \| \| \| `public [ClassNode](../../../../codehaus/groovy/ast/classnode)[]` \| `[visitTypeList](#visitTypeList(org.apache.groovy.parser.antlr4.GroovyParser%24TypeListContext))(org.apache.groovy.parser.antlr4.GroovyParser$TypeListContext ctx)` \| \| \| `public [VariableExpression](../../../../codehaus/groovy/ast/expr/variableexpression)` \| `[visitTypeNamePair](#visitTypeNamePair(org.apache.groovy.parser.antlr4.GroovyParser%24TypeNamePairContext))(org.apache.groovy.parser.antlr4.GroovyParser$TypeNamePairContext ctx)` \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Expression](../../../../codehaus/groovy/ast/expr/expression "Expression")>` \| `[visitTypeNamePairs](#visitTypeNamePairs(org.apache.groovy.parser.antlr4.GroovyParser%24TypeNamePairsContext))(org.apache.groovy.parser.antlr4.GroovyParser$TypeNamePairsContext ctx)` \| \| \| `public [GenericsType](../../../../codehaus/groovy/ast/genericstype)` \| `[visitTypeParameter](#visitTypeParameter(org.apache.groovy.parser.antlr4.GroovyParser%24TypeParameterContext))(org.apache.groovy.parser.antlr4.GroovyParser$TypeParameterContext ctx)` \| \| \| `public [GenericsType](../../../../codehaus/groovy/ast/genericstype)[]` \| `[visitTypeParameters](#visitTypeParameters(org.apache.groovy.parser.antlr4.GroovyParser%24TypeParametersContext))(org.apache.groovy.parser.antlr4.GroovyParser$TypeParametersContext ctx)` \| \| \| `public [Expression](../../../../codehaus/groovy/ast/expr/expression)` \| `[visitUnaryAddExprAlt](#visitUnaryAddExprAlt(org.apache.groovy.parser.antlr4.GroovyParser%24UnaryAddExprAltContext))(org.apache.groovy.parser.antlr4.GroovyParser$UnaryAddExprAltContext ctx)` \| \| \| `public [Expression](../../../../codehaus/groovy/ast/expr/expression)` \| `[visitUnaryNotExprAlt](#visitUnaryNotExprAlt(org.apache.groovy.parser.antlr4.GroovyParser%24UnaryNotExprAltContext))(org.apache.groovy.parser.antlr4.GroovyParser$UnaryNotExprAltContext ctx)` \| \| \| `public [AstBuilder.DeclarationListStatement](astbuilder.declarationliststatement)` \| `[visitVariableDeclaration](#visitVariableDeclaration(org.apache.groovy.parser.antlr4.GroovyParser%24VariableDeclarationContext))(org.apache.groovy.parser.antlr4.GroovyParser$VariableDeclarationContext ctx)` \| \| \| `public [DeclarationExpression](../../../../codehaus/groovy/ast/expr/declarationexpression)` \| `[visitVariableDeclarator](#visitVariableDeclarator(org.apache.groovy.parser.antlr4.GroovyParser%24VariableDeclaratorContext))(org.apache.groovy.parser.antlr4.GroovyParser$VariableDeclaratorContext ctx)` \| \| \| `public [VariableExpression](../../../../codehaus/groovy/ast/expr/variableexpression)` \| `[visitVariableDeclaratorId](#visitVariableDeclaratorId(org.apache.groovy.parser.antlr4.GroovyParser%24VariableDeclaratorIdContext))(org.apache.groovy.parser.antlr4.GroovyParser$VariableDeclaratorIdContext ctx)` \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[DeclarationExpression](../../../../codehaus/groovy/ast/expr/declarationexpression "DeclarationExpression")>` \| `[visitVariableDeclarators](#visitVariableDeclarators(org.apache.groovy.parser.antlr4.GroovyParser%24VariableDeclaratorsContext))(org.apache.groovy.parser.antlr4.GroovyParser$VariableDeclaratorsContext ctx)` \| \| \| `public [Expression](../../../../codehaus/groovy/ast/expr/expression)` \| `[visitVariableInitializer](#visitVariableInitializer(org.apache.groovy.parser.antlr4.GroovyParser%24VariableInitializerContext))(org.apache.groovy.parser.antlr4.GroovyParser$VariableInitializerContext ctx)` \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Expression](../../../../codehaus/groovy/ast/expr/expression "Expression")>` \| `[visitVariableInitializers](#visitVariableInitializers(org.apache.groovy.parser.antlr4.GroovyParser%24VariableInitializersContext))(org.apache.groovy.parser.antlr4.GroovyParser$VariableInitializersContext ctx)` \| \| \| `public [ModifierNode](../../../../codehaus/groovy/ast/modifiernode)` \| `[visitVariableModifier](#visitVariableModifier(org.apache.groovy.parser.antlr4.GroovyParser%24VariableModifierContext))(org.apache.groovy.parser.antlr4.GroovyParser$VariableModifierContext ctx)` \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[ModifierNode](../../../../codehaus/groovy/ast/modifiernode "ModifierNode")>` \| `[visitVariableModifiers](#visitVariableModifiers(org.apache.groovy.parser.antlr4.GroovyParser%24VariableModifiersContext))(org.apache.groovy.parser.antlr4.GroovyParser$VariableModifiersContext ctx)` \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[ModifierNode](../../../../codehaus/groovy/ast/modifiernode "ModifierNode")>` \| `[visitVariableModifiersOpt](#visitVariableModifiersOpt(org.apache.groovy.parser.antlr4.GroovyParser%24VariableModifiersOptContext))(org.apache.groovy.parser.antlr4.GroovyParser$VariableModifiersOptContext ctx)` \| \| \| `public [TupleExpression](../../../../codehaus/groovy/ast/expr/tupleexpression)` \| `[visitVariableNames](#visitVariableNames(org.apache.groovy.parser.antlr4.GroovyParser%24VariableNamesContext))(org.apache.groovy.parser.antlr4.GroovyParser$VariableNamesContext ctx)` \| \| \| `public [WhileStatement](../../../../codehaus/groovy/ast/stmt/whilestatement)` \| `[visitWhileStmtAlt](#visitWhileStmtAlt(org.apache.groovy.parser.antlr4.GroovyParser%24WhileStmtAltContext))(org.apache.groovy.parser.antlr4.GroovyParser$WhileStmtAltContext ctx)` \| \| \| `public [ReturnStatement](../../../../codehaus/groovy/ast/stmt/returnstatement)` \| `[visitYieldStatement](#visitYieldStatement(org.apache.groovy.parser.antlr4.GroovyLangParser.YieldStatementContext))([YieldStatementContext](groovylangparser.yieldstatementcontext) ctx)` \| \| \| `public [ReturnStatement](../../../../codehaus/groovy/ast/stmt/returnstatement)` \| `[visitYieldStmtAlt](#visitYieldStmtAlt(org.apache.groovy.parser.antlr4.GroovyLangParser.YieldStmtAltContext))([YieldStmtAltContext](groovylangparser.yieldstmtaltcontext) ctx)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor` \| `org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitAnnotation(org.apache.groovy.parser.antlr4.GroovyParser$AnnotationContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitTypeArgument(org.apache.groovy.parser.antlr4.GroovyParser$TypeArgumentContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitReturnType(org.apache.groovy.parser.antlr4.GroovyParser$ReturnTypeContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitType(org.apache.groovy.parser.antlr4.GroovyParser$TypeContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitBlockStmtAlt(org.apache.groovy.parser.antlr4.GroovyParser$BlockStmtAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitParenPrmrAlt(org.apache.groovy.parser.antlr4.GroovyParser$ParenPrmrAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitMapPrmrAlt(org.apache.groovy.parser.antlr4.GroovyParser$MapPrmrAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitListPrmrAlt(org.apache.groovy.parser.antlr4.GroovyParser$ListPrmrAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitBreakStmtAlt(org.apache.groovy.parser.antlr4.GroovyParser$BreakStmtAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitAssertStmtAlt(org.apache.groovy.parser.antlr4.GroovyParser$AssertStmtAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitEmptyStmtAlt(org.apache.groovy.parser.antlr4.GroovyParser$EmptyStmtAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitLoopStatement(org.apache.groovy.parser.antlr4.GroovyParser$LoopStatementContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitExpression(org.apache.groovy.parser.antlr4.GroovyParser$ExpressionContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitRparen(org.apache.groovy.parser.antlr4.GroovyParser$RparenContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitSep(org.apache.groovy.parser.antlr4.GroovyParser$SepContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitPrimary(org.apache.groovy.parser.antlr4.GroovyParser$PrimaryContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitNls(org.apache.groovy.parser.antlr4.GroovyParser$NlsContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitBlockStatement(org.apache.groovy.parser.antlr4.GroovyParser$BlockStatementContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitBreakStatement(org.apache.groovy.parser.antlr4.GroovyParser$BreakStatementContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitAssertStatement(org.apache.groovy.parser.antlr4.GroovyParser$AssertStatementContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitContinueStatement(org.apache.groovy.parser.antlr4.GroovyParser$ContinueStatementContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitPostfixExpression(org.apache.groovy.parser.antlr4.GroovyParser$PostfixExpressionContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitStatement(org.apache.groovy.parser.antlr4.GroovyParser$StatementContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitCompilationUnit(org.apache.groovy.parser.antlr4.GroovyParser$CompilationUnitContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitSwitchExpression(org.apache.groovy.parser.antlr4.GroovyParser$SwitchExpressionContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitBlock(org.apache.groovy.parser.antlr4.GroovyParser$BlockContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitIdentifier(org.apache.groovy.parser.antlr4.GroovyParser$IdentifierContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitPrimitiveType(org.apache.groovy.parser.antlr4.GroovyParser$PrimitiveTypeContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitLiteral(org.apache.groovy.parser.antlr4.GroovyParser$LiteralContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitModifiers(org.apache.groovy.parser.antlr4.GroovyParser$ModifiersContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitTypeParameter(org.apache.groovy.parser.antlr4.GroovyParser$TypeParameterContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitForControl(org.apache.groovy.parser.antlr4.GroovyParser$ForControlContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitFinallyBlock(org.apache.groovy.parser.antlr4.GroovyParser$FinallyBlockContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitResources(org.apache.groovy.parser.antlr4.GroovyParser$ResourcesContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitForInit(org.apache.groovy.parser.antlr4.GroovyParser$ForInitContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitCatchType(org.apache.groovy.parser.antlr4.GroovyParser$CatchTypeContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitForUpdate(org.apache.groovy.parser.antlr4.GroovyParser$ForUpdateContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitResourceList(org.apache.groovy.parser.antlr4.GroovyParser$ResourceListContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitTypeList(org.apache.groovy.parser.antlr4.GroovyParser$TypeListContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitClassBody(org.apache.groovy.parser.antlr4.GroovyParser$ClassBodyContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitArguments(org.apache.groovy.parser.antlr4.GroovyParser$ArgumentsContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitEnumConstants(org.apache.groovy.parser.antlr4.GroovyParser$EnumConstantsContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitMethodBody(org.apache.groovy.parser.antlr4.GroovyParser$MethodBodyContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitTypeBound(org.apache.groovy.parser.antlr4.GroovyParser$TypeBoundContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitModifiersOpt(org.apache.groovy.parser.antlr4.GroovyParser$ModifiersOptContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitMethodName(org.apache.groovy.parser.antlr4.GroovyParser$MethodNameContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitClassName(org.apache.groovy.parser.antlr4.GroovyParser$ClassNameContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitStringLiteral(org.apache.groovy.parser.antlr4.GroovyParser$StringLiteralContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitTypeNamePairs(org.apache.groovy.parser.antlr4.GroovyParser$TypeNamePairsContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitElementValue(org.apache.groovy.parser.antlr4.GroovyParser$ElementValueContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitNamePart(org.apache.groovy.parser.antlr4.GroovyParser$NamePartContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitCreator(org.apache.groovy.parser.antlr4.GroovyParser$CreatorContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitMapEntryList(org.apache.groovy.parser.antlr4.GroovyParser$MapEntryListContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitMapEntry(org.apache.groovy.parser.antlr4.GroovyParser$MapEntryContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitParExpression(org.apache.groovy.parser.antlr4.GroovyParser$ParExpressionContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitGstring(org.apache.groovy.parser.antlr4.GroovyParser$GstringContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitMapEntryLabel(org.apache.groovy.parser.antlr4.GroovyParser$MapEntryLabelContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitCreatedName(org.apache.groovy.parser.antlr4.GroovyParser$CreatedNameContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitTypeArguments(org.apache.groovy.parser.antlr4.GroovyParser$TypeArgumentsContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitVariableNames(org.apache.groovy.parser.antlr4.GroovyParser$VariableNamesContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitGstringPath(org.apache.groovy.parser.antlr4.GroovyParser$GstringPathContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitKeywords(org.apache.groovy.parser.antlr4.GroovyParser$KeywordsContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitClosure(org.apache.groovy.parser.antlr4.GroovyParser$ClosureContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitLambdaBody(org.apache.groovy.parser.antlr4.GroovyParser$LambdaBodyContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitEmptyDimsOpt(org.apache.groovy.parser.antlr4.GroovyParser$EmptyDimsOptContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitEmptyDims(org.apache.groovy.parser.antlr4.GroovyParser$EmptyDimsContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitElementValues(org.apache.groovy.parser.antlr4.GroovyParser$ElementValuesContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitTypeNamePair(org.apache.groovy.parser.antlr4.GroovyParser$TypeNamePairContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitDim(org.apache.groovy.parser.antlr4.GroovyParser$DimContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitResource(org.apache.groovy.parser.antlr4.GroovyParser$ResourceContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitPathElement(org.apache.groovy.parser.antlr4.GroovyParser$PathElementContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitSwitchLabel(org.apache.groovy.parser.antlr4.GroovyParser$SwitchLabelContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitGstringValue(org.apache.groovy.parser.antlr4.GroovyParser$GstringValueContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitBuiltInType(org.apache.groovy.parser.antlr4.GroovyParser$BuiltInTypeContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitMap(org.apache.groovy.parser.antlr4.GroovyParser$MapContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitList(org.apache.groovy.parser.antlr4.GroovyParser$ListContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitCatchClause(org.apache.groovy.parser.antlr4.GroovyParser$CatchClauseContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitForStmtAlt(org.apache.groovy.parser.antlr4.GroovyParser$ForStmtAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitModifier(org.apache.groovy.parser.antlr4.GroovyParser$ModifierContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitReturnStmtAlt(org.apache.groovy.parser.antlr4.GroovyParser$ReturnStmtAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitLoopStmtAlt(org.apache.groovy.parser.antlr4.GroovyParser$LoopStmtAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitWhileStmtAlt(org.apache.groovy.parser.antlr4.GroovyParser$WhileStmtAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitYieldStmtAlt(org.apache.groovy.parser.antlr4.GroovyParser$YieldStmtAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitAndExprAlt(org.apache.groovy.parser.antlr4.GroovyParser$AndExprAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitThrowStmtAlt(org.apache.groovy.parser.antlr4.GroovyParser$ThrowStmtAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitRegexExprAlt(org.apache.groovy.parser.antlr4.GroovyParser$RegexExprAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitPowerExprAlt(org.apache.groovy.parser.antlr4.GroovyParser$PowerExprAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitCastExprAlt(org.apache.groovy.parser.antlr4.GroovyParser$CastExprAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitNewPrmrAlt(org.apache.groovy.parser.antlr4.GroovyParser$NewPrmrAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitShiftExprAlt(org.apache.groovy.parser.antlr4.GroovyParser$ShiftExprAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitSuperPrmrAlt(org.apache.groovy.parser.antlr4.GroovyParser$SuperPrmrAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitSwitchExprAlt(org.apache.groovy.parser.antlr4.GroovyParser$SwitchExprAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitThisPrmrAlt(org.apache.groovy.parser.antlr4.GroovyParser$ThisPrmrAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitAnonymousInnerClassDeclaration(org.apache.groovy.parser.antlr4.GroovyParser$AnonymousInnerClassDeclarationContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitSwitchBlockStatementExpressionGroup(org.apache.groovy.parser.antlr4.GroovyParser$SwitchBlockStatementExpressionGroupContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitClosureOrLambdaExpressionPrmrAlt(org.apache.groovy.parser.antlr4.GroovyParser$ClosureOrLambdaExpressionPrmrAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitLocalVariableDeclarationStmtAlt(org.apache.groovy.parser.antlr4.GroovyParser$LocalVariableDeclarationStmtAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitClassOrInterfaceModifiersOpt(org.apache.groovy.parser.antlr4.GroovyParser$ClassOrInterfaceModifiersOptContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitLocalVariableDeclaration(org.apache.groovy.parser.antlr4.GroovyParser$LocalVariableDeclarationContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitScriptStatements(org.apache.groovy.parser.antlr4.GroovyParser$ScriptStatementsContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitYieldStatement(org.apache.groovy.parser.antlr4.GroovyParser$YieldStatementContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitVariableDeclaratorId(org.apache.groovy.parser.antlr4.GroovyParser$VariableDeclaratorIdContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitTypeParameters(org.apache.groovy.parser.antlr4.GroovyParser$TypeParametersContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitFormalParameters(org.apache.groovy.parser.antlr4.GroovyParser$FormalParametersContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitIfElseStatement(org.apache.groovy.parser.antlr4.GroovyParser$IfElseStatementContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitClassicalForControl(org.apache.groovy.parser.antlr4.GroovyParser$ClassicalForControlContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitClassDeclaration(org.apache.groovy.parser.antlr4.GroovyParser$ClassDeclarationContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitEnhancedForControl(org.apache.groovy.parser.antlr4.GroovyParser$EnhancedForControlContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitSwitchStatement(org.apache.groovy.parser.antlr4.GroovyParser$SwitchStatementContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitExpressionInPar(org.apache.groovy.parser.antlr4.GroovyParser$ExpressionInParContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitAnnotationsOpt(org.apache.groovy.parser.antlr4.GroovyParser$AnnotationsOptContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitExpressionList(org.apache.groovy.parser.antlr4.GroovyParser$ExpressionListContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitVariableInitializers(org.apache.groovy.parser.antlr4.GroovyParser$VariableInitializersContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitMethodDeclaration(org.apache.groovy.parser.antlr4.GroovyParser$MethodDeclarationContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitMemberDeclaration(org.apache.groovy.parser.antlr4.GroovyParser$MemberDeclarationContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitEnhancedStatementExpression(org.apache.groovy.parser.antlr4.GroovyParser$EnhancedStatementExpressionContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitBlockStatementsOpt(org.apache.groovy.parser.antlr4.GroovyParser$BlockStatementsOptContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitFieldDeclaration(org.apache.groovy.parser.antlr4.GroovyParser$FieldDeclarationContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitVariableDeclarators(org.apache.groovy.parser.antlr4.GroovyParser$VariableDeclaratorsContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitVariableInitializer(org.apache.groovy.parser.antlr4.GroovyParser$VariableInitializerContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitCompactConstructorDeclaration(org.apache.groovy.parser.antlr4.GroovyParser$CompactConstructorDeclarationContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitQualifiedClassNameList(org.apache.groovy.parser.antlr4.GroovyParser$QualifiedClassNameListContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitVariableDeclaration(org.apache.groovy.parser.antlr4.GroovyParser$VariableDeclarationContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitCommandExpression(org.apache.groovy.parser.antlr4.GroovyParser$CommandExpressionContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitEnhancedArgumentListInPar(org.apache.groovy.parser.antlr4.GroovyParser$EnhancedArgumentListInParContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitStandardLambdaParameters(org.apache.groovy.parser.antlr4.GroovyParser$StandardLambdaParametersContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitFormalParameterList(org.apache.groovy.parser.antlr4.GroovyParser$FormalParameterListContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitQualifiedClassName(org.apache.groovy.parser.antlr4.GroovyParser$QualifiedClassNameContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitIndexPropertyArgs(org.apache.groovy.parser.antlr4.GroovyParser$IndexPropertyArgsContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitNonWildcardTypeArguments(org.apache.groovy.parser.antlr4.GroovyParser$NonWildcardTypeArgumentsContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitNamedPropertyArgs(org.apache.groovy.parser.antlr4.GroovyParser$NamedPropertyArgsContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitDynamicMemberName(org.apache.groovy.parser.antlr4.GroovyParser$DynamicMemberNameContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitTypeArgumentsOrDiamond(org.apache.groovy.parser.antlr4.GroovyParser$TypeArgumentsOrDiamondContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitClosureOrLambdaExpression(org.apache.groovy.parser.antlr4.GroovyParser$ClosureOrLambdaExpressionContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitExpressionListElement(org.apache.groovy.parser.antlr4.GroovyParser$ExpressionListElementContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitPathExpression(org.apache.groovy.parser.antlr4.GroovyParser$PathExpressionContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitStandardLambdaExpression(org.apache.groovy.parser.antlr4.GroovyParser$StandardLambdaExpressionContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitCastParExpression(org.apache.groovy.parser.antlr4.GroovyParser$CastParExpressionContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitArrayInitializer(org.apache.groovy.parser.antlr4.GroovyParser$ArrayInitializerContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitSwitchBlockStatementGroup(org.apache.groovy.parser.antlr4.GroovyParser$SwitchBlockStatementGroupContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitVariableModifier(org.apache.groovy.parser.antlr4.GroovyParser$VariableModifierContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitCommandExprAlt(org.apache.groovy.parser.antlr4.GroovyParser$CommandExprAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitThisFormalParameter(org.apache.groovy.parser.antlr4.GroovyParser$ThisFormalParameterContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitCommandArgument(org.apache.groovy.parser.antlr4.GroovyParser$CommandArgumentContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitElementValuePair(org.apache.groovy.parser.antlr4.GroovyParser$ElementValuePairContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitLabeledStmtAlt(org.apache.groovy.parser.antlr4.GroovyParser$LabeledStmtAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitAssignmentExprAlt(org.apache.groovy.parser.antlr4.GroovyParser$AssignmentExprAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitBlockStatements(org.apache.groovy.parser.antlr4.GroovyParser$BlockStatementsContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitClassOrInterfaceType(org.apache.groovy.parser.antlr4.GroovyParser$ClassOrInterfaceTypeContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitElementValuePairs(org.apache.groovy.parser.antlr4.GroovyParser$ElementValuePairsContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitTryCatchStatement(org.apache.groovy.parser.antlr4.GroovyParser$TryCatchStatementContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitAnnotatedQualifiedClassName(org.apache.groovy.parser.antlr4.GroovyParser$AnnotatedQualifiedClassNameContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitImportDeclaration(org.apache.groovy.parser.antlr4.GroovyParser$ImportDeclarationContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitDoWhileStmtAlt(org.apache.groovy.parser.antlr4.GroovyParser$DoWhileStmtAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitAnnotationName(org.apache.groovy.parser.antlr4.GroovyParser$AnnotationNameContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitVariableModifiersOpt(org.apache.groovy.parser.antlr4.GroovyParser$VariableModifiersOptContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitConditionalStatement(org.apache.groovy.parser.antlr4.GroovyParser$ConditionalStatementContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitVariableModifiers(org.apache.groovy.parser.antlr4.GroovyParser$VariableModifiersContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitVariableDeclarator(org.apache.groovy.parser.antlr4.GroovyParser$VariableDeclaratorContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitClassBodyDeclaration(org.apache.groovy.parser.antlr4.GroovyParser$ClassBodyDeclarationContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitSwitchExpressionLabel(org.apache.groovy.parser.antlr4.GroovyParser$SwitchExpressionLabelContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitTypeDeclaration(org.apache.groovy.parser.antlr4.GroovyParser$TypeDeclarationContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitEnhancedArgumentListElement(org.apache.groovy.parser.antlr4.GroovyParser$EnhancedArgumentListElementContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitPackageDeclaration(org.apache.groovy.parser.antlr4.GroovyParser$PackageDeclarationContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitSynchronizedStmtAlt(org.apache.groovy.parser.antlr4.GroovyParser$SynchronizedStmtAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitFormalParameter(org.apache.groovy.parser.antlr4.GroovyParser$FormalParameterContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitMultipleAssignmentExprAlt(org.apache.groovy.parser.antlr4.GroovyParser$MultipleAssignmentExprAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitClassOrInterfaceModifier(org.apache.groovy.parser.antlr4.GroovyParser$ClassOrInterfaceModifierContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitElementValueArrayInitializer(org.apache.groovy.parser.antlr4.GroovyParser$ElementValueArrayInitializerContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitQualifiedStandardClassName(org.apache.groovy.parser.antlr4.GroovyParser$QualifiedStandardClassNameContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitClassOrInterfaceModifiers(org.apache.groovy.parser.antlr4.GroovyParser$ClassOrInterfaceModifiersContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitUnaryAddExprAlt(org.apache.groovy.parser.antlr4.GroovyParser$UnaryAddExprAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitLogicalOrExprAlt(org.apache.groovy.parser.antlr4.GroovyParser$LogicalOrExprAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitEqualityExprAlt(org.apache.groovy.parser.antlr4.GroovyParser$EqualityExprAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitAdditiveExprAlt(org.apache.groovy.parser.antlr4.GroovyParser$AdditiveExprAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitMultiplicativeExprAlt(org.apache.groovy.parser.antlr4.GroovyParser$MultiplicativeExprAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitUnaryNotExprAlt(org.apache.groovy.parser.antlr4.GroovyParser$UnaryNotExprAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitConditionalExprAlt(org.apache.groovy.parser.antlr4.GroovyParser$ConditionalExprAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitExclusiveOrExprAlt(org.apache.groovy.parser.antlr4.GroovyParser$ExclusiveOrExprAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitIntegerLiteralAlt(org.apache.groovy.parser.antlr4.GroovyParser$IntegerLiteralAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitNullLiteralAlt(org.apache.groovy.parser.antlr4.GroovyParser$NullLiteralAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitIdentifierPrmrAlt(org.apache.groovy.parser.antlr4.GroovyParser$IdentifierPrmrAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitLogicalAndExprAlt(org.apache.groovy.parser.antlr4.GroovyParser$LogicalAndExprAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitFloatingPointLiteralAlt(org.apache.groovy.parser.antlr4.GroovyParser$FloatingPointLiteralAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitBooleanLiteralAlt(org.apache.groovy.parser.antlr4.GroovyParser$BooleanLiteralAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitInclusiveOrExprAlt(org.apache.groovy.parser.antlr4.GroovyParser$InclusiveOrExprAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitRelationalExprAlt(org.apache.groovy.parser.antlr4.GroovyParser$RelationalExprAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitScriptStatement(org.apache.groovy.parser.antlr4.GroovyParser$ScriptStatementContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitQualifiedNameElement(org.apache.groovy.parser.antlr4.GroovyParser$QualifiedNameElementContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitConditionalStmtAlt(org.apache.groovy.parser.antlr4.GroovyParser$ConditionalStmtAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitStringLiteralAlt(org.apache.groovy.parser.antlr4.GroovyParser$StringLiteralAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitTryCatchStmtAlt(org.apache.groovy.parser.antlr4.GroovyParser$TryCatchStmtAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitBuiltInTypePrmrAlt(org.apache.groovy.parser.antlr4.GroovyParser$BuiltInTypePrmrAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitGstringPrmrAlt(org.apache.groovy.parser.antlr4.GroovyParser$GstringPrmrAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitLiteralPrmrAlt(org.apache.groovy.parser.antlr4.GroovyParser$LiteralPrmrAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitQualifiedNameElements(org.apache.groovy.parser.antlr4.GroovyParser$QualifiedNameElementsContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitPostfixExprAlt(org.apache.groovy.parser.antlr4.GroovyParser$PostfixExprAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitContinueStmtAlt(org.apache.groovy.parser.antlr4.GroovyParser$ContinueStmtAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitExpressionStmtAlt(org.apache.groovy.parser.antlr4.GroovyParser$ExpressionStmtAltContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitElementValuePairName(org.apache.groovy.parser.antlr4.GroovyParser$ElementValuePairNameContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitStatementExpression(org.apache.groovy.parser.antlr4.GroovyParser$StatementExpressionContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitQualifiedName(org.apache.groovy.parser.antlr4.GroovyParser$QualifiedNameContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitEnumConstant(org.apache.groovy.parser.antlr4.GroovyParser$EnumConstantContext), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visit(org.antlr.v4.runtime.tree.ParseTree), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitChildren(org.antlr.v4.runtime.tree.RuleNode), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitErrorNode(org.antlr.v4.runtime.tree.ErrorNode), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#visitTerminal(org.antlr.v4.runtime.tree.TerminalNode), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#wait(long, int), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#wait(), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#wait(long), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#equals(java.lang.Object), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#toString(), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#hashCode(), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#getClass(), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#notify(), org.apache.groovy.parser.antlr4.GroovyParserBaseVisitor#notifyAll()` \| Constructor Detail ------------------ ### public AstBuilder([SourceUnit](../../../../codehaus/groovy/control/sourceunit) sourceUnit, boolean groovydocEnabled, boolean runtimeGroovydocEnabled) Method Detail ------------- ### public [BlockStatement](../../../../codehaus/groovy/ast/stmt/blockstatement) appendStatementsToBlockStatement([BlockStatement](../../../../codehaus/groovy/ast/stmt/blockstatement) bs, [Statement](../../../../codehaus/groovy/ast/stmt/statement) statements) ### public [ModuleNode](../../../../codehaus/groovy/ast/modulenode) buildAST() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void syntaxError([Recognizer](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Recognizer.html "Recognizer") recognizer, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") offendingSymbol, int line, int charPositionInLine, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") msg, [RecognitionException](https://www.antlr.org/api/Java/org/antlr/v4/runtime/RecognitionException.html "RecognitionException") e) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") visit([ParseTree](https://www.antlr.org/api/Java/org/antlr/v4/runtime/tree/ParseTree.html "ParseTree") tree) Visit tree safely, no NPE occurred when the tree is null. Parameters:* `tree` - an AST node Returns: the visiting result ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [BinaryExpression](../../../../codehaus/groovy/ast/expr/binaryexpression) visitAdditiveExprAlt(org.apache.groovy.parser.antlr4.GroovyParser$AdditiveExprAltContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [BinaryExpression](../../../../codehaus/groovy/ast/expr/binaryexpression) visitAndExprAlt(org.apache.groovy.parser.antlr4.GroovyParser$AndExprAltContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ClassNode](../../../../codehaus/groovy/ast/classnode) visitAnnotatedQualifiedClassName(org.apache.groovy.parser.antlr4.GroovyParser$AnnotatedQualifiedClassNameContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [AnnotationNode](../../../../codehaus/groovy/ast/annotationnode) visitAnnotation(org.apache.groovy.parser.antlr4.GroovyParser$AnnotationContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") visitAnnotationName(org.apache.groovy.parser.antlr4.GroovyParser$AnnotationNameContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[AnnotationNode](../../../../codehaus/groovy/ast/annotationnode "AnnotationNode")> visitAnnotationsOpt(org.apache.groovy.parser.antlr4.GroovyParser$AnnotationsOptContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [InnerClassNode](../../../../codehaus/groovy/ast/innerclassnode) visitAnonymousInnerClassDeclaration(org.apache.groovy.parser.antlr4.GroovyParser$AnonymousInnerClassDeclarationContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Expression](../../../../codehaus/groovy/ast/expr/expression) visitArguments(org.apache.groovy.parser.antlr4.GroovyParser$ArgumentsContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Expression](../../../../codehaus/groovy/ast/expr/expression "Expression")> visitArrayInitializer(org.apache.groovy.parser.antlr4.GroovyParser$ArrayInitializerContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [AssertStatement](../../../../codehaus/groovy/ast/stmt/assertstatement) visitAssertStatement(org.apache.groovy.parser.antlr4.GroovyParser$AssertStatementContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [BinaryExpression](../../../../codehaus/groovy/ast/expr/binaryexpression) visitAssignmentExprAlt(org.apache.groovy.parser.antlr4.GroovyParser$AssignmentExprAltContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Statement](../../../../codehaus/groovy/ast/stmt/statement) visitBlock(org.apache.groovy.parser.antlr4.GroovyParser$BlockContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Statement](../../../../codehaus/groovy/ast/stmt/statement) visitBlockStatement(org.apache.groovy.parser.antlr4.GroovyParser$BlockStatementContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [BlockStatement](../../../../codehaus/groovy/ast/stmt/blockstatement) visitBlockStatements(org.apache.groovy.parser.antlr4.GroovyParser$BlockStatementsContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [BlockStatement](../../../../codehaus/groovy/ast/stmt/blockstatement) visitBlockStatementsOpt(org.apache.groovy.parser.antlr4.GroovyParser$BlockStatementsOptContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ConstantExpression](../../../../codehaus/groovy/ast/expr/constantexpression) visitBooleanLiteralAlt(org.apache.groovy.parser.antlr4.GroovyParser$BooleanLiteralAltContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [BreakStatement](../../../../codehaus/groovy/ast/stmt/breakstatement) visitBreakStatement(org.apache.groovy.parser.antlr4.GroovyParser$BreakStatementContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [VariableExpression](../../../../codehaus/groovy/ast/expr/variableexpression) visitBuiltInType(org.apache.groovy.parser.antlr4.GroovyParser$BuiltInTypeContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [CastExpression](../../../../codehaus/groovy/ast/expr/castexpression) visitCastExprAlt(org.apache.groovy.parser.antlr4.GroovyParser$CastExprAltContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ClassNode](../../../../codehaus/groovy/ast/classnode) visitCastParExpression(org.apache.groovy.parser.antlr4.GroovyParser$CastParExpressionContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[CatchStatement](../../../../codehaus/groovy/ast/stmt/catchstatement "CatchStatement")> visitCatchClause(org.apache.groovy.parser.antlr4.GroovyParser$CatchClauseContext ctx) Multi-catch(1..\) clause will be unpacked to several normal catch clauses, so the return type is List Parameters:* `ctx` - the parse tree Returns: a list of CatchStatement instances ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[ClassNode](../../../../codehaus/groovy/ast/classnode "ClassNode")> visitCatchType(org.apache.groovy.parser.antlr4.GroovyParser$CatchTypeContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Void](https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html "Void") visitClassBody(org.apache.groovy.parser.antlr4.GroovyParser$ClassBodyContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Void](https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html "Void") visitClassBodyDeclaration(org.apache.groovy.parser.antlr4.GroovyParser$ClassBodyDeclarationContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ClassNode](../../../../codehaus/groovy/ast/classnode) visitClassDeclaration(org.apache.groovy.parser.antlr4.GroovyParser$ClassDeclarationContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") visitClassName(org.apache.groovy.parser.antlr4.GroovyParser$ClassNameContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ModifierNode](../../../../codehaus/groovy/ast/modifiernode) visitClassOrInterfaceModifier(org.apache.groovy.parser.antlr4.GroovyParser$ClassOrInterfaceModifierContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[ModifierNode](../../../../codehaus/groovy/ast/modifiernode "ModifierNode")> visitClassOrInterfaceModifiers(org.apache.groovy.parser.antlr4.GroovyParser$ClassOrInterfaceModifiersContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[ModifierNode](../../../../codehaus/groovy/ast/modifiernode "ModifierNode")> visitClassOrInterfaceModifiersOpt(org.apache.groovy.parser.antlr4.GroovyParser$ClassOrInterfaceModifiersOptContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ClassNode](../../../../codehaus/groovy/ast/classnode) visitClassOrInterfaceType(org.apache.groovy.parser.antlr4.GroovyParser$ClassOrInterfaceTypeContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Tuple2](../../../../../groovy/lang/tuple2 "Tuple2")<[Parameter](../../../../codehaus/groovy/ast/parameter "Parameter"), [Expression](../../../../codehaus/groovy/ast/expr/expression "Expression")> visitClassicalForControl(org.apache.groovy.parser.antlr4.GroovyParser$ClassicalForControlContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ClosureExpression](../../../../codehaus/groovy/ast/expr/closureexpression) visitClosure(org.apache.groovy.parser.antlr4.GroovyParser$ClosureContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ClosureExpression](../../../../codehaus/groovy/ast/expr/closureexpression) visitClosureOrLambdaExpression(org.apache.groovy.parser.antlr4.GroovyParser$ClosureOrLambdaExpressionContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Expression](../../../../codehaus/groovy/ast/expr/expression) visitCommandArgument(org.apache.groovy.parser.antlr4.GroovyParser$CommandArgumentContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ExpressionStatement](../../../../codehaus/groovy/ast/stmt/expressionstatement) visitCommandExprAlt(org.apache.groovy.parser.antlr4.GroovyParser$CommandExprAltContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Expression](../../../../codehaus/groovy/ast/expr/expression) visitCommandExpression(org.apache.groovy.parser.antlr4.GroovyParser$CommandExpressionContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [MethodNode](../../../../codehaus/groovy/ast/methodnode) visitCompactConstructorDeclaration(org.apache.groovy.parser.antlr4.GroovyParser$CompactConstructorDeclarationContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ModuleNode](../../../../codehaus/groovy/ast/modulenode) visitCompilationUnit(org.apache.groovy.parser.antlr4.GroovyParser$CompilationUnitContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Expression](../../../../codehaus/groovy/ast/expr/expression) visitConditionalExprAlt(org.apache.groovy.parser.antlr4.GroovyParser$ConditionalExprAltContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Statement](../../../../codehaus/groovy/ast/stmt/statement) visitConditionalStatement(org.apache.groovy.parser.antlr4.GroovyParser$ConditionalStatementContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ContinueStatement](../../../../codehaus/groovy/ast/stmt/continuestatement) visitContinueStatement(org.apache.groovy.parser.antlr4.GroovyParser$ContinueStatementContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ClassNode](../../../../codehaus/groovy/ast/classnode) visitCreatedName(org.apache.groovy.parser.antlr4.GroovyParser$CreatedNameContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Expression](../../../../codehaus/groovy/ast/expr/expression) visitCreator(org.apache.groovy.parser.antlr4.GroovyParser$CreatorContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Tuple3](../../../../../groovy/lang/tuple3 "Tuple3")<[Expression](../../../../codehaus/groovy/ast/expr/expression "Expression"), [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[AnnotationNode](../../../../codehaus/groovy/ast/annotationnode "AnnotationNode")>, [TerminalNode](https://www.antlr.org/api/Java/org/antlr/v4/runtime/tree/TerminalNode.html "TerminalNode")> visitDim(org.apache.groovy.parser.antlr4.GroovyParser$DimContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [DoWhileStatement](../../../../codehaus/groovy/ast/stmt/dowhilestatement) visitDoWhileStmtAlt(org.apache.groovy.parser.antlr4.GroovyParser$DoWhileStmtAltContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Expression](../../../../codehaus/groovy/ast/expr/expression) visitDynamicMemberName(org.apache.groovy.parser.antlr4.GroovyParser$DynamicMemberNameContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Expression](../../../../codehaus/groovy/ast/expr/expression) visitElementValue(org.apache.groovy.parser.antlr4.GroovyParser$ElementValueContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ListExpression](../../../../codehaus/groovy/ast/expr/listexpression) visitElementValueArrayInitializer(org.apache.groovy.parser.antlr4.GroovyParser$ElementValueArrayInitializerContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Tuple2](../../../../../groovy/lang/tuple2 "Tuple2")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Expression](../../../../codehaus/groovy/ast/expr/expression "Expression")> visitElementValuePair(org.apache.groovy.parser.antlr4.GroovyParser$ElementValuePairContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Expression](../../../../codehaus/groovy/ast/expr/expression "Expression")> visitElementValuePairs(org.apache.groovy.parser.antlr4.GroovyParser$ElementValuePairsContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Tuple2](../../../../../groovy/lang/tuple2 "Tuple2")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Expression](../../../../codehaus/groovy/ast/expr/expression "Expression")>> visitElementValues(org.apache.groovy.parser.antlr4.GroovyParser$ElementValuesContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[AnnotationNode](../../../../codehaus/groovy/ast/annotationnode "AnnotationNode")>> visitEmptyDims(org.apache.groovy.parser.antlr4.GroovyParser$EmptyDimsContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[AnnotationNode](../../../../codehaus/groovy/ast/annotationnode "AnnotationNode")>> visitEmptyDimsOpt(org.apache.groovy.parser.antlr4.GroovyParser$EmptyDimsOptContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Expression](../../../../codehaus/groovy/ast/expr/expression) visitEnhancedArgumentListElement(org.apache.groovy.parser.antlr4.GroovyParser$EnhancedArgumentListElementContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Expression](../../../../codehaus/groovy/ast/expr/expression) visitEnhancedArgumentListInPar(org.apache.groovy.parser.antlr4.GroovyParser$EnhancedArgumentListInParContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Tuple2](../../../../../groovy/lang/tuple2 "Tuple2")<[Parameter](../../../../codehaus/groovy/ast/parameter "Parameter"), [Expression](../../../../codehaus/groovy/ast/expr/expression "Expression")> visitEnhancedForControl(org.apache.groovy.parser.antlr4.GroovyParser$EnhancedForControlContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Expression](../../../../codehaus/groovy/ast/expr/expression) visitEnhancedStatementExpression(org.apache.groovy.parser.antlr4.GroovyParser$EnhancedStatementExpressionContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [FieldNode](../../../../codehaus/groovy/ast/fieldnode) visitEnumConstant(org.apache.groovy.parser.antlr4.GroovyParser$EnumConstantContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[FieldNode](../../../../codehaus/groovy/ast/fieldnode "FieldNode")> visitEnumConstants(org.apache.groovy.parser.antlr4.GroovyParser$EnumConstantsContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [BinaryExpression](../../../../codehaus/groovy/ast/expr/binaryexpression) visitEqualityExprAlt(org.apache.groovy.parser.antlr4.GroovyParser$EqualityExprAltContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [BinaryExpression](../../../../codehaus/groovy/ast/expr/binaryexpression) visitExclusiveOrExprAlt(org.apache.groovy.parser.antlr4.GroovyParser$ExclusiveOrExprAltContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Expression](../../../../codehaus/groovy/ast/expr/expression) visitExpressionInPar(org.apache.groovy.parser.antlr4.GroovyParser$ExpressionInParContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Expression](../../../../codehaus/groovy/ast/expr/expression "Expression")> visitExpressionList(org.apache.groovy.parser.antlr4.GroovyParser$ExpressionListContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Expression](../../../../codehaus/groovy/ast/expr/expression) visitExpressionListElement(org.apache.groovy.parser.antlr4.GroovyParser$ExpressionListElementContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Void](https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html "Void") visitFieldDeclaration(org.apache.groovy.parser.antlr4.GroovyParser$FieldDeclarationContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Statement](../../../../codehaus/groovy/ast/stmt/statement) visitFinallyBlock(org.apache.groovy.parser.antlr4.GroovyParser$FinallyBlockContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ConstantExpression](../../../../codehaus/groovy/ast/expr/constantexpression) visitFloatingPointLiteralAlt(org.apache.groovy.parser.antlr4.GroovyParser$FloatingPointLiteralAltContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Tuple2](../../../../../groovy/lang/tuple2 "Tuple2")<[Parameter](../../../../codehaus/groovy/ast/parameter "Parameter"), [Expression](../../../../codehaus/groovy/ast/expr/expression "Expression")> visitForControl(org.apache.groovy.parser.antlr4.GroovyParser$ForControlContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") @[SuppressWarnings](https://docs.oracle.com/javase/8/docs/api/java/lang/SuppressWarnings.html "SuppressWarnings")("unchecked") public [Expression](../../../../codehaus/groovy/ast/expr/expression) visitForInit(org.apache.groovy.parser.antlr4.GroovyParser$ForInitContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ForStatement](../../../../codehaus/groovy/ast/stmt/forstatement) visitForStmtAlt(org.apache.groovy.parser.antlr4.GroovyParser$ForStmtAltContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Expression](../../../../codehaus/groovy/ast/expr/expression) visitForUpdate(org.apache.groovy.parser.antlr4.GroovyParser$ForUpdateContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Parameter](../../../../codehaus/groovy/ast/parameter) visitFormalParameter(org.apache.groovy.parser.antlr4.GroovyParser$FormalParameterContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Parameter](../../../../codehaus/groovy/ast/parameter)[] visitFormalParameterList(org.apache.groovy.parser.antlr4.GroovyParser$FormalParameterListContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Parameter](../../../../codehaus/groovy/ast/parameter)[] visitFormalParameters(org.apache.groovy.parser.antlr4.GroovyParser$FormalParametersContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [GStringExpression](../../../../codehaus/groovy/ast/expr/gstringexpression) visitGstring(org.apache.groovy.parser.antlr4.GroovyParser$GstringContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Expression](../../../../codehaus/groovy/ast/expr/expression) visitGstringPath(org.apache.groovy.parser.antlr4.GroovyParser$GstringPathContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Expression](../../../../codehaus/groovy/ast/expr/expression) visitGstringValue(org.apache.groovy.parser.antlr4.GroovyParser$GstringValueContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") visitIdentifier(org.apache.groovy.parser.antlr4.GroovyParser$IdentifierContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Expression](../../../../codehaus/groovy/ast/expr/expression) visitIdentifierPrmrAlt(org.apache.groovy.parser.antlr4.GroovyParser$IdentifierPrmrAltContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [IfStatement](../../../../codehaus/groovy/ast/stmt/ifstatement) visitIfElseStatement(org.apache.groovy.parser.antlr4.GroovyParser$IfElseStatementContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ImportNode](../../../../codehaus/groovy/ast/importnode) visitImportDeclaration(org.apache.groovy.parser.antlr4.GroovyParser$ImportDeclarationContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [BinaryExpression](../../../../codehaus/groovy/ast/expr/binaryexpression) visitInclusiveOrExprAlt(org.apache.groovy.parser.antlr4.GroovyParser$InclusiveOrExprAltContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Tuple2](../../../../../groovy/lang/tuple2 "Tuple2")<[Token](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Token.html "Token"), [Expression](../../../../codehaus/groovy/ast/expr/expression "Expression")> visitIndexPropertyArgs(org.apache.groovy.parser.antlr4.GroovyParser$IndexPropertyArgsContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ConstantExpression](../../../../codehaus/groovy/ast/expr/constantexpression) visitIntegerLiteralAlt(org.apache.groovy.parser.antlr4.GroovyParser$IntegerLiteralAltContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ConstantExpression](../../../../codehaus/groovy/ast/expr/constantexpression) visitKeywords(org.apache.groovy.parser.antlr4.GroovyParser$KeywordsContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Statement](../../../../codehaus/groovy/ast/stmt/statement) visitLabeledStmtAlt(org.apache.groovy.parser.antlr4.GroovyParser$LabeledStmtAltContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Statement](../../../../codehaus/groovy/ast/stmt/statement) visitLambdaBody(org.apache.groovy.parser.antlr4.GroovyParser$LambdaBodyContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ListExpression](../../../../codehaus/groovy/ast/expr/listexpression) visitList(org.apache.groovy.parser.antlr4.GroovyParser$ListContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [AstBuilder.DeclarationListStatement](astbuilder.declarationliststatement) visitLocalVariableDeclaration(org.apache.groovy.parser.antlr4.GroovyParser$LocalVariableDeclarationContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [BinaryExpression](../../../../codehaus/groovy/ast/expr/binaryexpression) visitLogicalAndExprAlt(org.apache.groovy.parser.antlr4.GroovyParser$LogicalAndExprAltContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [BinaryExpression](../../../../codehaus/groovy/ast/expr/binaryexpression) visitLogicalOrExprAlt(org.apache.groovy.parser.antlr4.GroovyParser$LogicalOrExprAltContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Statement](../../../../codehaus/groovy/ast/stmt/statement) visitLoopStmtAlt(org.apache.groovy.parser.antlr4.GroovyParser$LoopStmtAltContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [MapExpression](../../../../codehaus/groovy/ast/expr/mapexpression) visitMap(org.apache.groovy.parser.antlr4.GroovyParser$MapContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [MapEntryExpression](../../../../codehaus/groovy/ast/expr/mapentryexpression) visitMapEntry(org.apache.groovy.parser.antlr4.GroovyParser$MapEntryContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Expression](../../../../codehaus/groovy/ast/expr/expression) visitMapEntryLabel(org.apache.groovy.parser.antlr4.GroovyParser$MapEntryLabelContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[MapEntryExpression](../../../../codehaus/groovy/ast/expr/mapentryexpression "MapEntryExpression")> visitMapEntryList(org.apache.groovy.parser.antlr4.GroovyParser$MapEntryListContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Void](https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html "Void") visitMemberDeclaration(org.apache.groovy.parser.antlr4.GroovyParser$MemberDeclarationContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Statement](../../../../codehaus/groovy/ast/stmt/statement) visitMethodBody(org.apache.groovy.parser.antlr4.GroovyParser$MethodBodyContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [MethodNode](../../../../codehaus/groovy/ast/methodnode) visitMethodDeclaration(org.apache.groovy.parser.antlr4.GroovyParser$MethodDeclarationContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") visitMethodName(org.apache.groovy.parser.antlr4.GroovyParser$MethodNameContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ModifierNode](../../../../codehaus/groovy/ast/modifiernode) visitModifier(org.apache.groovy.parser.antlr4.GroovyParser$ModifierContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[ModifierNode](../../../../codehaus/groovy/ast/modifiernode "ModifierNode")> visitModifiers(org.apache.groovy.parser.antlr4.GroovyParser$ModifiersContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[ModifierNode](../../../../codehaus/groovy/ast/modifiernode "ModifierNode")> visitModifiersOpt(org.apache.groovy.parser.antlr4.GroovyParser$ModifiersOptContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [BinaryExpression](../../../../codehaus/groovy/ast/expr/binaryexpression) visitMultipleAssignmentExprAlt(org.apache.groovy.parser.antlr4.GroovyParser$MultipleAssignmentExprAltContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [BinaryExpression](../../../../codehaus/groovy/ast/expr/binaryexpression) visitMultiplicativeExprAlt(org.apache.groovy.parser.antlr4.GroovyParser$MultiplicativeExprAltContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Expression](../../../../codehaus/groovy/ast/expr/expression) visitNamePart(org.apache.groovy.parser.antlr4.GroovyParser$NamePartContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[MapEntryExpression](../../../../codehaus/groovy/ast/expr/mapentryexpression "MapEntryExpression")> visitNamedPropertyArgs(org.apache.groovy.parser.antlr4.GroovyParser$NamedPropertyArgsContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Expression](../../../../codehaus/groovy/ast/expr/expression) visitNewPrmrAlt(org.apache.groovy.parser.antlr4.GroovyParser$NewPrmrAltContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [GenericsType](../../../../codehaus/groovy/ast/genericstype)[] visitNonWildcardTypeArguments(org.apache.groovy.parser.antlr4.GroovyParser$NonWildcardTypeArgumentsContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ConstantExpression](../../../../codehaus/groovy/ast/expr/constantexpression) visitNullLiteralAlt(org.apache.groovy.parser.antlr4.GroovyParser$NullLiteralAltContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [PackageNode](../../../../codehaus/groovy/ast/packagenode) visitPackageDeclaration(org.apache.groovy.parser.antlr4.GroovyParser$PackageDeclarationContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Expression](../../../../codehaus/groovy/ast/expr/expression) visitParExpression(org.apache.groovy.parser.antlr4.GroovyParser$ParExpressionContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Expression](../../../../codehaus/groovy/ast/expr/expression) visitPathElement(org.apache.groovy.parser.antlr4.GroovyParser$PathElementContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Expression](../../../../codehaus/groovy/ast/expr/expression) visitPathExpression(org.apache.groovy.parser.antlr4.GroovyParser$PathExpressionContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Expression](../../../../codehaus/groovy/ast/expr/expression) visitPostfixExpression(org.apache.groovy.parser.antlr4.GroovyParser$PostfixExpressionContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [BinaryExpression](../../../../codehaus/groovy/ast/expr/binaryexpression) visitPowerExprAlt(org.apache.groovy.parser.antlr4.GroovyParser$PowerExprAltContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ClassNode](../../../../codehaus/groovy/ast/classnode) visitPrimitiveType(org.apache.groovy.parser.antlr4.GroovyParser$PrimitiveTypeContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void visitPropertyExpression([PropertyExpression](../../../../codehaus/groovy/ast/expr/propertyexpression) expression) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ClassNode](../../../../codehaus/groovy/ast/classnode) visitQualifiedClassName(org.apache.groovy.parser.antlr4.GroovyParser$QualifiedClassNameContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ClassNode](../../../../codehaus/groovy/ast/classnode)[] visitQualifiedClassNameList(org.apache.groovy.parser.antlr4.GroovyParser$QualifiedClassNameListContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") visitQualifiedName(org.apache.groovy.parser.antlr4.GroovyParser$QualifiedNameContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ClassNode](../../../../codehaus/groovy/ast/classnode) visitQualifiedStandardClassName(org.apache.groovy.parser.antlr4.GroovyParser$QualifiedStandardClassNameContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [BinaryExpression](../../../../codehaus/groovy/ast/expr/binaryexpression) visitRegexExprAlt(org.apache.groovy.parser.antlr4.GroovyParser$RegexExprAltContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Expression](../../../../codehaus/groovy/ast/expr/expression) visitRelationalExprAlt(org.apache.groovy.parser.antlr4.GroovyParser$RelationalExprAltContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ExpressionStatement](../../../../codehaus/groovy/ast/stmt/expressionstatement) visitResource(org.apache.groovy.parser.antlr4.GroovyParser$ResourceContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[ExpressionStatement](../../../../codehaus/groovy/ast/stmt/expressionstatement "ExpressionStatement")> visitResourceList(org.apache.groovy.parser.antlr4.GroovyParser$ResourceListContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[ExpressionStatement](../../../../codehaus/groovy/ast/stmt/expressionstatement "ExpressionStatement")> visitResources(org.apache.groovy.parser.antlr4.GroovyParser$ResourcesContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void visitReturnStatement([ReturnStatement](../../../../codehaus/groovy/ast/stmt/returnstatement) statement) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ReturnStatement](../../../../codehaus/groovy/ast/stmt/returnstatement) visitReturnStmtAlt(org.apache.groovy.parser.antlr4.GroovyParser$ReturnStmtAltContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ClassNode](../../../../codehaus/groovy/ast/classnode) visitReturnType(org.apache.groovy.parser.antlr4.GroovyParser$ReturnTypeContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[ASTNode](../../../../codehaus/groovy/ast/astnode "ASTNode")> visitScriptStatements(org.apache.groovy.parser.antlr4.GroovyParser$ScriptStatementsContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Expression](../../../../codehaus/groovy/ast/expr/expression) visitShiftExprAlt(org.apache.groovy.parser.antlr4.GroovyParser$ShiftExprAltContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [LambdaExpression](../../../../codehaus/groovy/ast/expr/lambdaexpression) visitStandardLambdaExpression(org.apache.groovy.parser.antlr4.GroovyParser$StandardLambdaExpressionContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Parameter](../../../../codehaus/groovy/ast/parameter)[] visitStandardLambdaParameters(org.apache.groovy.parser.antlr4.GroovyParser$StandardLambdaParametersContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ConstantExpression](../../../../codehaus/groovy/ast/expr/constantexpression) visitStringLiteral(org.apache.groovy.parser.antlr4.GroovyParser$StringLiteralContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [VariableExpression](../../../../codehaus/groovy/ast/expr/variableexpression) visitSuperPrmrAlt(org.apache.groovy.parser.antlr4.GroovyParser$SuperPrmrAltContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") @[SuppressWarnings](https://docs.oracle.com/javase/8/docs/api/java/lang/SuppressWarnings.html "SuppressWarnings")("unchecked") public [Tuple3](../../../../../groovy/lang/tuple3 "Tuple3")<[List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Statement](../../../../codehaus/groovy/ast/stmt/statement "Statement")>, [Boolean](https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html "Boolean"), [Boolean](https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html "Boolean")> visitSwitchBlockStatementExpressionGroup([SwitchBlockStatementExpressionGroupContext](groovylangparser.switchblockstatementexpressiongroupcontext) ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") @[SuppressWarnings](https://docs.oracle.com/javase/8/docs/api/java/lang/SuppressWarnings.html "SuppressWarnings")("unchecked") public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Statement](../../../../codehaus/groovy/ast/stmt/statement "Statement")> visitSwitchBlockStatementGroup(org.apache.groovy.parser.antlr4.GroovyParser$SwitchBlockStatementGroupContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Expression](../../../../codehaus/groovy/ast/expr/expression) visitSwitchExprAlt([SwitchExprAltContext](groovylangparser.switchexpraltcontext) ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [MethodCallExpression](../../../../codehaus/groovy/ast/expr/methodcallexpression) visitSwitchExpression([SwitchExpressionContext](groovylangparser.switchexpressioncontext) ctx) ``` switch(a) { case 0, 1 -> 'a'; case 2 -> 'b'; default -> 'z'; } ``` the above code will be transformed to: ``` {-> switch(a) { case 0: case 1: return 'a'; case 2: return 'b'; default: return 'z'; } }() ``` Parameters: `ctx` - the parse tree Returns: [MethodCallExpression](../../../../codehaus/groovy/ast/expr/methodcallexpression "MethodCallExpression") instance ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Tuple3](../../../../../groovy/lang/tuple3 "Tuple3")<[Token](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Token.html "Token"), [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Expression](../../../../codehaus/groovy/ast/expr/expression "Expression")>, [Integer](https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html "Integer")> visitSwitchExpressionLabel([SwitchExpressionLabelContext](groovylangparser.switchexpressionlabelcontext) ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Tuple2](../../../../../groovy/lang/tuple2 "Tuple2")<[Token](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Token.html "Token"), [Expression](../../../../codehaus/groovy/ast/expr/expression "Expression")> visitSwitchLabel(org.apache.groovy.parser.antlr4.GroovyParser$SwitchLabelContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [SwitchStatement](../../../../codehaus/groovy/ast/stmt/switchstatement) visitSwitchStatement(org.apache.groovy.parser.antlr4.GroovyParser$SwitchStatementContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [SynchronizedStatement](../../../../codehaus/groovy/ast/stmt/synchronizedstatement) visitSynchronizedStmtAlt(org.apache.groovy.parser.antlr4.GroovyParser$SynchronizedStmtAltContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Parameter](../../../../codehaus/groovy/ast/parameter) visitThisFormalParameter(org.apache.groovy.parser.antlr4.GroovyParser$ThisFormalParameterContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [VariableExpression](../../../../codehaus/groovy/ast/expr/variableexpression) visitThisPrmrAlt(org.apache.groovy.parser.antlr4.GroovyParser$ThisPrmrAltContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void visitThrowStatement([ThrowStatement](../../../../codehaus/groovy/ast/stmt/throwstatement) statement) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ThrowStatement](../../../../codehaus/groovy/ast/stmt/throwstatement) visitThrowStmtAlt(org.apache.groovy.parser.antlr4.GroovyParser$ThrowStmtAltContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Statement](../../../../codehaus/groovy/ast/stmt/statement) visitTryCatchStatement(org.apache.groovy.parser.antlr4.GroovyParser$TryCatchStatementContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ClassNode](../../../../codehaus/groovy/ast/classnode) visitType(org.apache.groovy.parser.antlr4.GroovyParser$TypeContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [GenericsType](../../../../codehaus/groovy/ast/genericstype) visitTypeArgument(org.apache.groovy.parser.antlr4.GroovyParser$TypeArgumentContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [GenericsType](../../../../codehaus/groovy/ast/genericstype)[] visitTypeArguments(org.apache.groovy.parser.antlr4.GroovyParser$TypeArgumentsContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [GenericsType](../../../../codehaus/groovy/ast/genericstype)[] visitTypeArgumentsOrDiamond(org.apache.groovy.parser.antlr4.GroovyParser$TypeArgumentsOrDiamondContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ClassNode](../../../../codehaus/groovy/ast/classnode)[] visitTypeBound(org.apache.groovy.parser.antlr4.GroovyParser$TypeBoundContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ClassNode](../../../../codehaus/groovy/ast/classnode) visitTypeDeclaration(org.apache.groovy.parser.antlr4.GroovyParser$TypeDeclarationContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ClassNode](../../../../codehaus/groovy/ast/classnode)[] visitTypeList(org.apache.groovy.parser.antlr4.GroovyParser$TypeListContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [VariableExpression](../../../../codehaus/groovy/ast/expr/variableexpression) visitTypeNamePair(org.apache.groovy.parser.antlr4.GroovyParser$TypeNamePairContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Expression](../../../../codehaus/groovy/ast/expr/expression "Expression")> visitTypeNamePairs(org.apache.groovy.parser.antlr4.GroovyParser$TypeNamePairsContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [GenericsType](../../../../codehaus/groovy/ast/genericstype) visitTypeParameter(org.apache.groovy.parser.antlr4.GroovyParser$TypeParameterContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [GenericsType](../../../../codehaus/groovy/ast/genericstype)[] visitTypeParameters(org.apache.groovy.parser.antlr4.GroovyParser$TypeParametersContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Expression](../../../../codehaus/groovy/ast/expr/expression) visitUnaryAddExprAlt(org.apache.groovy.parser.antlr4.GroovyParser$UnaryAddExprAltContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Expression](../../../../codehaus/groovy/ast/expr/expression) visitUnaryNotExprAlt(org.apache.groovy.parser.antlr4.GroovyParser$UnaryNotExprAltContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [AstBuilder.DeclarationListStatement](astbuilder.declarationliststatement) visitVariableDeclaration(org.apache.groovy.parser.antlr4.GroovyParser$VariableDeclarationContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [DeclarationExpression](../../../../codehaus/groovy/ast/expr/declarationexpression) visitVariableDeclarator(org.apache.groovy.parser.antlr4.GroovyParser$VariableDeclaratorContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [VariableExpression](../../../../codehaus/groovy/ast/expr/variableexpression) visitVariableDeclaratorId(org.apache.groovy.parser.antlr4.GroovyParser$VariableDeclaratorIdContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[DeclarationExpression](../../../../codehaus/groovy/ast/expr/declarationexpression "DeclarationExpression")> visitVariableDeclarators(org.apache.groovy.parser.antlr4.GroovyParser$VariableDeclaratorsContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Expression](../../../../codehaus/groovy/ast/expr/expression) visitVariableInitializer(org.apache.groovy.parser.antlr4.GroovyParser$VariableInitializerContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Expression](../../../../codehaus/groovy/ast/expr/expression "Expression")> visitVariableInitializers(org.apache.groovy.parser.antlr4.GroovyParser$VariableInitializersContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ModifierNode](../../../../codehaus/groovy/ast/modifiernode) visitVariableModifier(org.apache.groovy.parser.antlr4.GroovyParser$VariableModifierContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[ModifierNode](../../../../codehaus/groovy/ast/modifiernode "ModifierNode")> visitVariableModifiers(org.apache.groovy.parser.antlr4.GroovyParser$VariableModifiersContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[ModifierNode](../../../../codehaus/groovy/ast/modifiernode "ModifierNode")> visitVariableModifiersOpt(org.apache.groovy.parser.antlr4.GroovyParser$VariableModifiersOptContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [TupleExpression](../../../../codehaus/groovy/ast/expr/tupleexpression) visitVariableNames(org.apache.groovy.parser.antlr4.GroovyParser$VariableNamesContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [WhileStatement](../../../../codehaus/groovy/ast/stmt/whilestatement) visitWhileStmtAlt(org.apache.groovy.parser.antlr4.GroovyParser$WhileStmtAltContext ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ReturnStatement](../../../../codehaus/groovy/ast/stmt/returnstatement) visitYieldStatement([YieldStatementContext](groovylangparser.yieldstatementcontext) ctx) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ReturnStatement](../../../../codehaus/groovy/ast/stmt/returnstatement) visitYieldStmtAlt([YieldStmtAltContext](groovylangparser.yieldstmtaltcontext) ctx)	programming_docs
groovy [Java] Class GroovydocManager [Java] Class GroovydocManager ============================= * org.apache.groovy.parser.antlr4.GroovydocManager ``` public class GroovydocManager extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` A utilities for managing groovydoc, e.g. 1) extracting groovydoc from groovy AST; 2) TODO extracting tags from groovydoc; 3) attach groovydoc to AST node as metadata Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DOC\_COMMENT](#DOC_COMMENT)` \| \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[GroovydocManager](#GroovydocManager(boolean,%20boolean))(boolean groovydocEnabled, boolean runtimeGroovydocEnabled)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public void` \| `[handle](#handle(org.codehaus.groovy.ast.ASTNode,%20org.apache.groovy.parser.antlr4.GroovyParser%24GroovyParserRuleContext))([ASTNode](../../../../codehaus/groovy/ast/astnode) node, org.apache.groovy.parser.antlr4.GroovyParser$GroovyParserRuleContext ctx)`Attach doc comment to member node as meta data \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Field Detail ------------ ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DOC\_COMMENT Constructor Detail ------------------ ### public GroovydocManager(boolean groovydocEnabled, boolean runtimeGroovydocEnabled) Method Detail ------------- ### public void handle([ASTNode](../../../../codehaus/groovy/ast/astnode) node, org.apache.groovy.parser.antlr4.GroovyParser$GroovyParserRuleContext ctx) Attach doc comment to member node as meta data groovy [Java] Class Antlr4ParserPlugin [Java] Class Antlr4ParserPlugin =============================== * org.apache.groovy.parser.antlr4.Antlr4ParserPlugin All Implemented Interfaces and Traits: [ParserPlugin](../../../../codehaus/groovy/control/parserplugin) ``` public class Antlr4ParserPlugin extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") implements [ParserPlugin](../../../../codehaus/groovy/control/parserplugin) ``` A parser plugin for the new parser. Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [ModuleNode](../../../../codehaus/groovy/ast/modulenode)` \| `[buildAST](#buildAST(org.codehaus.groovy.control.SourceUnit,%20java.lang.ClassLoader,%20org.codehaus.groovy.syntax.Reduction))([SourceUnit](../../../../codehaus/groovy/control/sourceunit) sourceUnit, [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html "ClassLoader") classLoader, [Reduction](../../../../codehaus/groovy/syntax/reduction) cst)` \| \| \| `public [Reduction](../../../../codehaus/groovy/syntax/reduction)` \| `[parseCST](#parseCST(org.codehaus.groovy.control.SourceUnit,%20java.io.Reader))([SourceUnit](../../../../codehaus/groovy/control/sourceunit) sourceUnit, [Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") reader)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ModuleNode](../../../../codehaus/groovy/ast/modulenode) buildAST([SourceUnit](../../../../codehaus/groovy/control/sourceunit) sourceUnit, [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html "ClassLoader") classLoader, [Reduction](../../../../codehaus/groovy/syntax/reduction) cst) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Reduction](../../../../codehaus/groovy/syntax/reduction) parseCST([SourceUnit](../../../../codehaus/groovy/control/sourceunit) sourceUnit, [Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") reader) groovy [Java] Class StringUtils [Java] Class StringUtils ======================== * org.apache.groovy.parser.antlr4.util.StringUtils ``` public class StringUtils extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Utilities for handling strings Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `static int` \| `[DOLLAR\_SLASHY](#DOLLAR_SLASHY)` \| \| \| `static int` \| `[NONE\_SLASHY](#NONE_SLASHY)` \| \| \| `static int` \| `[SLASHY](#SLASHY)` \| \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public static long` \| `[countChar](#countChar(java.lang.String,%20char))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text, char c)` \| \| \| `public static boolean` \| `[isEmpty](#isEmpty(java.lang.CharSequence))([CharSequence](https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html "CharSequence") cs)`Copied from Apache commons-lang3-3.6 \| \| \| `public static boolean` \| `[matches](#matches(java.lang.String,%20java.util.regex.Pattern))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text, [Pattern](https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html "Pattern") pattern)` \| \| \| `public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[removeCR](#removeCR(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text)` \| \| \| `public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[replace](#replace(java.lang.String,%20java.lang.String,%20java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") searchString, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") replacement)`The modified implementation is based on StringUtils#replace(String text, String searchString, String replacement, int max), Apache commons-lang3-3.6 \| \| \| `public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[replaceEscapes](#replaceEscapes(java.lang.String,%20int))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text, int slashyType)` \| \| \| `public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[replaceHexEscapes](#replaceHexEscapes(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text)` \| \| \| `public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[replaceOctalEscapes](#replaceOctalEscapes(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text)` \| \| \| `public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[replaceStandardEscapes](#replaceStandardEscapes(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text)` \| \| \| `public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[trimQuotations](#trimQuotations(java.lang.String,%20int))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text, int quotationLength)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Field Detail ------------ ### public static final int DOLLAR\_SLASHY ### public static final int NONE\_SLASHY ### public static final int SLASHY Method Detail ------------- ### public static long countChar([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text, char c) ### public static boolean isEmpty([CharSequence](https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html "CharSequence") cs) Copied from Apache commons-lang3-3.6 Checks if a CharSequence is empty ("") or null. ``` StringUtils.isEmpty(null) = true StringUtils.isEmpty("") = true StringUtils.isEmpty(" ") = false StringUtils.isEmpty("bob") = false StringUtils.isEmpty(" bob ") = false ``` NOTE: This method changed in Lang version 2.0. It no longer trims the CharSequence. That functionality is available in isBlank(). Parameters: `cs` - the CharSequence to check, may be null Returns: `true` if the CharSequence is empty or null ### public static boolean matches([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text, [Pattern](https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html "Pattern") pattern) ### public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") removeCR([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text) ### public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") replace([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") searchString, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") replacement) The modified implementation is based on StringUtils#replace(String text, String searchString, String replacement, int max), Apache commons-lang3-3.6 Replaces all occurrences of a String within another String. A `null` reference passed to this method is a no-op. ``` StringUtils.replace(null, , ) = null StringUtils.replace("", , ) = "" StringUtils.replace("any", null, ) = "any" StringUtils.replace("any", , null) = "any" StringUtils.replace("any", "", ) = "any" StringUtils.replace("aba", "a", null) = "aba" StringUtils.replace("aba", "a", "") = "b" StringUtils.replace("aba", "a", "z") = "zbz" ``` Parameters:* `text` - text to search and replace in, may be null `searchString` - the String to search for, may be null `replacement` - the String to replace it with, may be null Returns: the text with any replacements processed, `null` if null String input ### public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") replaceEscapes([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text, int slashyType) ### public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") replaceHexEscapes([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text) ### public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") replaceOctalEscapes([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text) ### public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") replaceStandardEscapes([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text) ### public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") trimQuotations([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text, int quotationLength) groovy [Java] Class PositionConfigureUtils [Java] Class PositionConfigureUtils =================================== * org.apache.groovy.parser.antlr4.util.PositionConfigureUtils ``` public class PositionConfigureUtils extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Utilities for configuring node positions Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| `<T extends ASTNode>` \| `public static T` \| `[configureAST](#configureAST(T,%20org.apache.groovy.parser.antlr4.GroovyParser%24GroovyParserRuleContext))(T astNode, org.apache.groovy.parser.antlr4.GroovyParser$GroovyParserRuleContext ctx)`Sets location(lineNumber, colNumber, lastLineNumber, lastColumnNumber) for node using standard context information. \| \| `<T extends ASTNode>` \| `public static T` \| `[configureAST](#configureAST(T,%20org.antlr.v4.runtime.tree.TerminalNode))(T astNode, [TerminalNode](https://www.antlr.org/api/Java/org/antlr/v4/runtime/tree/TerminalNode.html "TerminalNode") terminalNode)` \| \| `<T extends ASTNode>` \| `public static T` \| `[configureAST](#configureAST(T,%20org.antlr.v4.runtime.Token))(T astNode, [Token](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Token.html "Token") token)` \| \| `<T extends ASTNode>` \| `public static T` \| `[configureAST](#configureAST(T,%20org.codehaus.groovy.ast.ASTNode))(T astNode, [ASTNode](../../../../../codehaus/groovy/ast/astnode) source)` \| \| `<T extends ASTNode>` \| `public static T` \| `[configureAST](#configureAST(T,%20org.apache.groovy.parser.antlr4.GroovyParser%24GroovyParserRuleContext,%20org.codehaus.groovy.ast.ASTNode))(T astNode, org.apache.groovy.parser.antlr4.GroovyParser$GroovyParserRuleContext ctx, [ASTNode](../../../../../codehaus/groovy/ast/astnode) initialStop)` \| \| `<T extends ASTNode>` \| `public static T` \| `[configureAST](#configureAST(T,%20org.codehaus.groovy.ast.ASTNode,%20org.codehaus.groovy.ast.ASTNode))(T astNode, [ASTNode](../../../../../codehaus/groovy/ast/astnode) start, [ASTNode](../../../../../codehaus/groovy/ast/astnode) stop)` \| \| `<T extends ASTNode>` \| `public static void` \| `[configureEndPosition](#configureEndPosition(T,%20org.antlr.v4.runtime.Token))(T astNode, [Token](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Token.html "Token") token)` \| \| \| `public static [Tuple2](../../../../../../groovy/lang/tuple2 "Tuple2")<[Integer](https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html "Integer"), [Integer](https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html "Integer")>` \| `[endPosition](#endPosition(org.antlr.v4.runtime.Token))([Token](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Token.html "Token") token)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### <T extends ASTNode> public static T configureAST(T astNode, org.apache.groovy.parser.antlr4.GroovyParser$GroovyParserRuleContext ctx) Sets location(lineNumber, colNumber, lastLineNumber, lastColumnNumber) for node using standard context information. Note: this method is implemented to be closed over ASTNode. It returns same node as it received in arguments. Parameters: `astNode` - Node to be modified. `ctx` - Context from which information is obtained. Returns: Modified astNode. ### <T extends ASTNode> public static T configureAST(T astNode, [TerminalNode](https://www.antlr.org/api/Java/org/antlr/v4/runtime/tree/TerminalNode.html "TerminalNode") terminalNode) ### <T extends ASTNode> public static T configureAST(T astNode, [Token](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Token.html "Token") token) ### <T extends ASTNode> public static T configureAST(T astNode, [ASTNode](../../../../../codehaus/groovy/ast/astnode) source) ### <T extends ASTNode> public static T configureAST(T astNode, org.apache.groovy.parser.antlr4.GroovyParser$GroovyParserRuleContext ctx, [ASTNode](../../../../../codehaus/groovy/ast/astnode) initialStop) ### <T extends ASTNode> public static T configureAST(T astNode, [ASTNode](../../../../../codehaus/groovy/ast/astnode) start, [ASTNode](../../../../../codehaus/groovy/ast/astnode) stop) ### <T extends ASTNode> public static void configureEndPosition(T astNode, [Token](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Token.html "Token") token) ### public static [Tuple2](../../../../../../groovy/lang/tuple2 "Tuple2")<[Integer](https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html "Integer"), [Integer](https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html "Integer")> endPosition([Token](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Token.html "Token") token)	programming_docs
groovy [Java] Class DescriptiveErrorStrategy [Java] Class DescriptiveErrorStrategy ===================================== * org.apache.groovy.parser.antlr4.internal.DescriptiveErrorStrategy ``` public class DescriptiveErrorStrategy extends [BailErrorStrategy](https://www.antlr.org/api/Java/org/antlr/v4/runtime/BailErrorStrategy.html "BailErrorStrategy") ``` Provide friendly error messages when parsing errors occurred. Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[DescriptiveErrorStrategy](#DescriptiveErrorStrategy(org.antlr.v4.runtime.CharStream))([CharStream](https://www.antlr.org/api/Java/org/antlr/v4/runtime/CharStream.html "CharStream") charStream)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[createFailedPredicateErrorMessage](#createFailedPredicateErrorMessage(org.apache.groovy.groovysh.Parser,%20org.antlr.v4.runtime.FailedPredicateException))(org.apache.groovy.groovysh.Parser recognizer, [FailedPredicateException](https://www.antlr.org/api/Java/org/antlr/v4/runtime/FailedPredicateException.html "FailedPredicateException") e)` \| \| \| `protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[createInputMismatchErrorMessage](#createInputMismatchErrorMessage(org.apache.groovy.groovysh.Parser,%20org.antlr.v4.runtime.InputMismatchException))(org.apache.groovy.groovysh.Parser recognizer, [InputMismatchException](https://www.antlr.org/api/Java/org/antlr/v4/runtime/InputMismatchException.html "InputMismatchException") e)` \| \| \| `protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[createNoViableAlternativeErrorMessage](#createNoViableAlternativeErrorMessage(org.apache.groovy.groovysh.Parser,%20org.antlr.v4.runtime.NoViableAltException))(org.apache.groovy.groovysh.Parser recognizer, [NoViableAltException](https://www.antlr.org/api/Java/org/antlr/v4/runtime/NoViableAltException.html "NoViableAltException") e)` \| \| \| `public void` \| `[recover](#recover(org.apache.groovy.groovysh.Parser,%20org.antlr.v4.runtime.RecognitionException))(org.apache.groovy.groovysh.Parser recognizer, [RecognitionException](https://www.antlr.org/api/Java/org/antlr/v4/runtime/RecognitionException.html "RecognitionException") e)` \| \| \| `public [Token](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Token.html "Token")` \| `[recoverInline](#recoverInline(org.apache.groovy.groovysh.Parser))(org.apache.groovy.groovysh.Parser recognizer)` \| \| \| `protected void` \| `[reportFailedPredicate](#reportFailedPredicate(org.apache.groovy.groovysh.Parser,%20org.antlr.v4.runtime.FailedPredicateException))(org.apache.groovy.groovysh.Parser recognizer, [FailedPredicateException](https://www.antlr.org/api/Java/org/antlr/v4/runtime/FailedPredicateException.html "FailedPredicateException") e)` \| \| \| `protected void` \| `[reportInputMismatch](#reportInputMismatch(org.apache.groovy.groovysh.Parser,%20org.antlr.v4.runtime.InputMismatchException))(org.apache.groovy.groovysh.Parser recognizer, [InputMismatchException](https://www.antlr.org/api/Java/org/antlr/v4/runtime/InputMismatchException.html "InputMismatchException") e)` \| \| \| `protected void` \| `[reportNoViableAlternative](#reportNoViableAlternative(org.apache.groovy.groovysh.Parser,%20org.antlr.v4.runtime.NoViableAltException))(org.apache.groovy.groovysh.Parser recognizer, [NoViableAltException](https://www.antlr.org/api/Java/org/antlr/v4/runtime/NoViableAltException.html "NoViableAltException") e)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [BailErrorStrategy](https://www.antlr.org/api/Java/org/antlr/v4/runtime/BailErrorStrategy.html "BailErrorStrategy")` \| `[sync](https://www.antlr.org/api/Java/org/antlr/v4/runtime/BailErrorStrategy.html#sync(org.antlr.v4.runtime.Parser) "sync"), [recoverInline](https://www.antlr.org/api/Java/org/antlr/v4/runtime/BailErrorStrategy.html#recoverInline(org.antlr.v4.runtime.Parser) "recoverInline"), [recover](https://www.antlr.org/api/Java/org/antlr/v4/runtime/BailErrorStrategy.html#recover(org.antlr.v4.runtime.Parser,%20org.antlr.v4.runtime.RecognitionException) "recover"), [reset](https://www.antlr.org/api/Java/org/antlr/v4/runtime/BailErrorStrategy.html#reset(org.antlr.v4.runtime.Parser) "reset"), [reportError](https://www.antlr.org/api/Java/org/antlr/v4/runtime/BailErrorStrategy.html#reportError(org.antlr.v4.runtime.Parser,%20org.antlr.v4.runtime.RecognitionException) "reportError"), [reportMatch](https://www.antlr.org/api/Java/org/antlr/v4/runtime/BailErrorStrategy.html#reportMatch(org.antlr.v4.runtime.Parser) "reportMatch"), [inErrorRecoveryMode](https://www.antlr.org/api/Java/org/antlr/v4/runtime/BailErrorStrategy.html#inErrorRecoveryMode(org.antlr.v4.runtime.Parser) "inErrorRecoveryMode"), [wait](https://www.antlr.org/api/Java/org/antlr/v4/runtime/BailErrorStrategy.html#wait(long,%20int) "wait"), [wait](https://www.antlr.org/api/Java/org/antlr/v4/runtime/BailErrorStrategy.html#wait() "wait"), [wait](https://www.antlr.org/api/Java/org/antlr/v4/runtime/BailErrorStrategy.html#wait(long) "wait"), [equals](https://www.antlr.org/api/Java/org/antlr/v4/runtime/BailErrorStrategy.html#equals(java.lang.Object) "equals"), [toString](https://www.antlr.org/api/Java/org/antlr/v4/runtime/BailErrorStrategy.html#toString() "toString"), [hashCode](https://www.antlr.org/api/Java/org/antlr/v4/runtime/BailErrorStrategy.html#hashCode() "hashCode"), [getClass](https://www.antlr.org/api/Java/org/antlr/v4/runtime/BailErrorStrategy.html#getClass() "getClass"), [notify](https://www.antlr.org/api/Java/org/antlr/v4/runtime/BailErrorStrategy.html#notify() "notify"), [notifyAll](https://www.antlr.org/api/Java/org/antlr/v4/runtime/BailErrorStrategy.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public DescriptiveErrorStrategy([CharStream](https://www.antlr.org/api/Java/org/antlr/v4/runtime/CharStream.html "CharStream") charStream) Method Detail ------------- ### protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") createFailedPredicateErrorMessage(org.apache.groovy.groovysh.Parser recognizer, [FailedPredicateException](https://www.antlr.org/api/Java/org/antlr/v4/runtime/FailedPredicateException.html "FailedPredicateException") e) ### protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") createInputMismatchErrorMessage(org.apache.groovy.groovysh.Parser recognizer, [InputMismatchException](https://www.antlr.org/api/Java/org/antlr/v4/runtime/InputMismatchException.html "InputMismatchException") e) ### protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") createNoViableAlternativeErrorMessage(org.apache.groovy.groovysh.Parser recognizer, [NoViableAltException](https://www.antlr.org/api/Java/org/antlr/v4/runtime/NoViableAltException.html "NoViableAltException") e) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void recover(org.apache.groovy.groovysh.Parser recognizer, [RecognitionException](https://www.antlr.org/api/Java/org/antlr/v4/runtime/RecognitionException.html "RecognitionException") e) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Token](https://www.antlr.org/api/Java/org/antlr/v4/runtime/Token.html "Token") recoverInline(org.apache.groovy.groovysh.Parser recognizer) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected void reportFailedPredicate(org.apache.groovy.groovysh.Parser recognizer, [FailedPredicateException](https://www.antlr.org/api/Java/org/antlr/v4/runtime/FailedPredicateException.html "FailedPredicateException") e) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected void reportInputMismatch(org.apache.groovy.groovysh.Parser recognizer, [InputMismatchException](https://www.antlr.org/api/Java/org/antlr/v4/runtime/InputMismatchException.html "InputMismatchException") e) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected void reportNoViableAlternative(org.apache.groovy.groovysh.Parser recognizer, [NoViableAltException](https://www.antlr.org/api/Java/org/antlr/v4/runtime/NoViableAltException.html "NoViableAltException") e) groovy [Java] Class LexerAtnManager [Java] Class LexerAtnManager ============================ * org.apache.groovy.parser.antlr4.internal.atnmanager.LexerAtnManager ``` public class LexerAtnManager extends [AtnManager](atnmanager) ``` Manage ATN for lexer to avoid memory leak Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `static [LexerAtnManager](lexeratnmanager)` \| `[INSTANCE](#INSTANCE)` \| \| Inherited fields \| Fields inherited from class \| Fields \| \| `class [AtnManager](atnmanager)` \| `[READ\_LOCK](atnmanager#READ_LOCK)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [ATN](https://www.antlr.org/api/Java/org/antlr/v4/runtime/atn/ATN.html "ATN")` \| `[getATN](#getATN())()` \| \| \| `protected boolean` \| `[shouldClearDfaCache](#shouldClearDfaCache())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AtnManager](atnmanager)` \| `[getATN](atnmanager#getATN()), [shouldClearDfaCache](atnmanager#shouldClearDfaCache())` \| Field Detail ------------ ### public static final [LexerAtnManager](lexeratnmanager) INSTANCE Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ATN](https://www.antlr.org/api/Java/org/antlr/v4/runtime/atn/ATN.html "ATN") getATN() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected boolean shouldClearDfaCache() groovy [Java] Class ParserAtnManager [Java] Class ParserAtnManager ============================= * org.apache.groovy.parser.antlr4.internal.atnmanager.ParserAtnManager ``` public class ParserAtnManager extends [AtnManager](atnmanager) ``` Manage ATN for parser to avoid memory leak Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `static [ParserAtnManager](parseratnmanager)` \| `[INSTANCE](#INSTANCE)` \| \| Inherited fields \| Fields inherited from class \| Fields \| \| `class [AtnManager](atnmanager)` \| `[READ\_LOCK](atnmanager#READ_LOCK)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [ATN](https://www.antlr.org/api/Java/org/antlr/v4/runtime/atn/ATN.html "ATN")` \| `[getATN](#getATN())()` \| \| \| `protected boolean` \| `[shouldClearDfaCache](#shouldClearDfaCache())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AtnManager](atnmanager)` \| `[getATN](atnmanager#getATN()), [shouldClearDfaCache](atnmanager#shouldClearDfaCache())` \| Field Detail ------------ ### public static final [ParserAtnManager](parseratnmanager) INSTANCE Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ATN](https://www.antlr.org/api/Java/org/antlr/v4/runtime/atn/ATN.html "ATN") getATN() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected boolean shouldClearDfaCache() groovy [Java] Class AtnManager [Java] Class AtnManager ======================= * org.apache.groovy.parser.antlr4.internal.atnmanager.AtnManager ``` public abstract class AtnManager extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Manage ATN to avoid memory leak Nested Class Summary -------------------- Nested classes \| Modifiers \| Name \| Description \| \| `protected class` \| `[AtnManager.AtnWrapper](atnmanager.atnwrapper)` \| \| Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `static [ReentrantReadWriteLock.ReadLock](https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/locks/ReentrantReadWriteLock.ReadLock.html "ReentrantReadWriteLock.ReadLock")` \| `[READ\_LOCK](#READ_LOCK)` \| \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public abstract [ATN](https://www.antlr.org/api/Java/org/antlr/v4/runtime/atn/ATN.html "ATN")` \| `[getATN](#getATN())()` \| \| \| `protected abstract boolean` \| `[shouldClearDfaCache](#shouldClearDfaCache())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Field Detail ------------ ### public static final [ReentrantReadWriteLock.ReadLock](https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/locks/ReentrantReadWriteLock.ReadLock.html "ReentrantReadWriteLock.ReadLock") READ\_LOCK Method Detail ------------- ### public abstract [ATN](https://www.antlr.org/api/Java/org/antlr/v4/runtime/atn/ATN.html "ATN") getATN() ### protected abstract boolean shouldClearDfaCache() groovy [Java] Class AtnManager.AtnWrapper [Java] Class AtnManager.AtnWrapper ================================== * org.apache.groovy.parser.antlr4.internal.atnmanager.AtnManager.AtnWrapper ``` protected class AtnManager.AtnWrapper ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[AtnWrapper](#AtnWrapper(org.antlr.v4.runtime.atn.ATN))([ATN](https://www.antlr.org/api/Java/org/antlr/v4/runtime/atn/ATN.html "ATN") atn)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [ATN](https://www.antlr.org/api/Java/org/antlr/v4/runtime/atn/ATN.html "ATN")` \| `[checkAndClear](#checkAndClear())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public AtnWrapper([ATN](https://www.antlr.org/api/Java/org/antlr/v4/runtime/atn/ATN.html "ATN") atn) Method Detail ------------- ### public [ATN](https://www.antlr.org/api/Java/org/antlr/v4/runtime/atn/ATN.html "ATN") checkAndClear() groovy [Java] Class DomToGroovy [Java] Class DomToGroovy ======================== * org.apache.groovy.xml.tools.DomToGroovy ``` public class DomToGroovy extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` A SAX handler for turning XML into Groovy scripts Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `protected boolean` \| `[inMixed](#inMixed)` \| \| \| `protected [Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>` \| `[keywords](#keywords)` \| \| \| `protected [IndentPrinter](../../../../../groovy/util/indentprinter)` \| `[out](#out)` \| \| \| `protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[qt](#qt)` \| \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[DomToGroovy](#DomToGroovy(java.io.PrintWriter))([PrintWriter](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html "PrintWriter") out)` \| \| `[DomToGroovy](#DomToGroovy(groovy.util.IndentPrinter))([IndentPrinter](../../../../../groovy/util/indentprinter) out)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `protected boolean` \| `[checkEscaping](#checkEscaping(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") localName)` \| \| \| `protected void` \| `[defineNamespace](#defineNamespace(java.util.Map,%20java.lang.String,%20java.lang.String))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") namespaces, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") prefix, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri)` \| \| \| `protected [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")` \| `[defineNamespaces](#defineNamespaces(javax.swing.text.Element,%20java.util.Map))([Element](https://docs.oracle.com/javase/8/docs/api/javax/swing/text/Element.html "Element") element, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") namespaces)` \| \| \| `protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[escapeQuote](#escapeQuote(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text)` \| \| \| `protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getAttributeValue](#getAttributeValue(org.w3c.dom.Attr))([Attr](https://docs.oracle.com/javase/8/docs/api/org/w3c/dom/Attr.html "Attr") attribute)` \| \| \| `protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getLocalName](#getLocalName(groovy.util.Node))([Node](../../../../../groovy/util/node) node)` \| \| \| `protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getTextNodeData](#getTextNodeData(org.w3c.dom.Text))([Text](https://docs.oracle.com/javase/8/docs/api/org/w3c/dom/Text.html "Text") node)` \| \| \| `public static void` \| `[main](#main(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")[] args)` \| \| \| `protected boolean` \| `[mixedContent](#mixedContent(groovy.util.NodeList))([NodeList](../../../../../groovy/util/nodelist) list)` \| \| \| `protected static [Document](https://docs.oracle.com/javase/8/docs/api/javax/swing/text/Document.html "Document")` \| `[parse](#parse(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") fileName)` \| \| \| `public static [Document](https://docs.oracle.com/javase/8/docs/api/javax/swing/text/Document.html "Document")` \| `[parse](#parse(java.io.File))([File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File") file)` \| \| \| `public static [Document](https://docs.oracle.com/javase/8/docs/api/javax/swing/text/Document.html "Document")` \| `[parse](#parse(java.io.Reader))([Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") input)` \| \| \| `public static [Document](https://docs.oracle.com/javase/8/docs/api/javax/swing/text/Document.html "Document")` \| `[parse](#parse(java.io.InputStream))([InputStream](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html "InputStream") input)` \| \| \| `public void` \| `[print](#print(javax.swing.text.Document))([Document](https://docs.oracle.com/javase/8/docs/api/javax/swing/text/Document.html "Document") document)` \| \| \| `protected void` \| `[print](#print(groovy.util.Node,%20java.util.Map,%20boolean))([Node](../../../../../groovy/util/node) node, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") namespaces, boolean endWithComma)` \| \| \| `protected void` \| `[print](#print(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text)` \| \| \| `protected void` \| `[printAttributeWithPrefix](#printAttributeWithPrefix(org.w3c.dom.Attr,%20java.lang.StringBuffer))([Attr](https://docs.oracle.com/javase/8/docs/api/org/w3c/dom/Attr.html "Attr") attribute, [StringBuffer](https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuffer.html "StringBuffer") buffer)` \| \| \| `protected boolean` \| `[printAttributeWithoutPrefix](#printAttributeWithoutPrefix(org.w3c.dom.Attr,%20boolean))([Attr](https://docs.oracle.com/javase/8/docs/api/org/w3c/dom/Attr.html "Attr") attribute, boolean hasAttribute)` \| \| \| `protected boolean` \| `[printAttributes](#printAttributes(javax.swing.text.Element))([Element](https://docs.oracle.com/javase/8/docs/api/javax/swing/text/Element.html "Element") element)` \| \| \| `protected void` \| `[printChildren](#printChildren(groovy.util.Node,%20java.util.Map))([Node](../../../../../groovy/util/node) parent, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") namespaces)` \| \| \| `protected void` \| `[printComment](#printComment(org.w3c.dom.Comment,%20boolean))([Comment](https://docs.oracle.com/javase/8/docs/api/org/w3c/dom/Comment.html "Comment") comment, boolean endWithComma)` \| \| \| `protected void` \| `[printElement](#printElement(javax.swing.text.Element,%20java.util.Map,%20boolean))([Element](https://docs.oracle.com/javase/8/docs/api/javax/swing/text/Element.html "Element") element, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") namespaces, boolean endWithComma)` \| \| \| `protected void` \| `[printEnd](#printEnd(java.lang.String,%20boolean))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text, boolean endWithComma)` \| \| \| `protected void` \| `[printIndent](#printIndent())()` \| \| \| `protected void` \| `[printPI](#printPI(org.w3c.dom.ProcessingInstruction,%20boolean))([ProcessingInstruction](https://docs.oracle.com/javase/8/docs/api/org/w3c/dom/ProcessingInstruction.html "ProcessingInstruction") instruction, boolean endWithComma)` \| \| \| `protected void` \| `[printQuoted](#printQuoted(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text)` \| \| \| `protected void` \| `[printText](#printText(org.w3c.dom.Text,%20boolean))([Text](https://docs.oracle.com/javase/8/docs/api/org/w3c/dom/Text.html "Text") node, boolean endWithComma)` \| \| \| `protected void` \| `[println](#println(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Field Detail ------------ ### protected boolean inMixed ### protected [Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> keywords ### protected [IndentPrinter](../../../../../groovy/util/indentprinter) out ### protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") qt Constructor Detail ------------------ ### public DomToGroovy([PrintWriter](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html "PrintWriter") out) ### public DomToGroovy([IndentPrinter](../../../../../groovy/util/indentprinter) out) Method Detail ------------- ### protected boolean checkEscaping([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") localName) ### protected void defineNamespace([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") namespaces, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") prefix, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri) ### protected [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") defineNamespaces([Element](https://docs.oracle.com/javase/8/docs/api/javax/swing/text/Element.html "Element") element, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") namespaces) ### protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") escapeQuote([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text) ### protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getAttributeValue([Attr](https://docs.oracle.com/javase/8/docs/api/org/w3c/dom/Attr.html "Attr") attribute) ### protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getLocalName([Node](../../../../../groovy/util/node) node) ### protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getTextNodeData([Text](https://docs.oracle.com/javase/8/docs/api/org/w3c/dom/Text.html "Text") node) ### public static void main([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")[] args) ### protected boolean mixedContent([NodeList](../../../../../groovy/util/nodelist) list) ### protected static [Document](https://docs.oracle.com/javase/8/docs/api/javax/swing/text/Document.html "Document") parse([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") fileName) ### public static [Document](https://docs.oracle.com/javase/8/docs/api/javax/swing/text/Document.html "Document") parse([File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File") file) ### public static [Document](https://docs.oracle.com/javase/8/docs/api/javax/swing/text/Document.html "Document") parse([Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") input) ### public static [Document](https://docs.oracle.com/javase/8/docs/api/javax/swing/text/Document.html "Document") parse([InputStream](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html "InputStream") input) ### public void print([Document](https://docs.oracle.com/javase/8/docs/api/javax/swing/text/Document.html "Document") document) ### protected void print([Node](../../../../../groovy/util/node) node, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") namespaces, boolean endWithComma) ### protected void print([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text) ### protected void printAttributeWithPrefix([Attr](https://docs.oracle.com/javase/8/docs/api/org/w3c/dom/Attr.html "Attr") attribute, [StringBuffer](https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuffer.html "StringBuffer") buffer) ### protected boolean printAttributeWithoutPrefix([Attr](https://docs.oracle.com/javase/8/docs/api/org/w3c/dom/Attr.html "Attr") attribute, boolean hasAttribute) ### protected boolean printAttributes([Element](https://docs.oracle.com/javase/8/docs/api/javax/swing/text/Element.html "Element") element) ### protected void printChildren([Node](../../../../../groovy/util/node) parent, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") namespaces) ### protected void printComment([Comment](https://docs.oracle.com/javase/8/docs/api/org/w3c/dom/Comment.html "Comment") comment, boolean endWithComma) ### protected void printElement([Element](https://docs.oracle.com/javase/8/docs/api/javax/swing/text/Element.html "Element") element, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") namespaces, boolean endWithComma) ### protected void printEnd([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text, boolean endWithComma) ### protected void printIndent() ### protected void printPI([ProcessingInstruction](https://docs.oracle.com/javase/8/docs/api/org/w3c/dom/ProcessingInstruction.html "ProcessingInstruction") instruction, boolean endWithComma) ### protected void printQuoted([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text) ### protected void printText([Text](https://docs.oracle.com/javase/8/docs/api/org/w3c/dom/Text.html "Text") node, boolean endWithComma) ### protected void println([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text)	programming_docs
groovy [Java] Class XmlExtensions [Java] Class XmlExtensions ========================== * org.apache.groovy.xml.extensions.XmlExtensions ``` public class XmlExtensions extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` This class defines all the new XML-related groovy methods which enhance the normal JDK XML classes when inside the Groovy environment. Static methods are used with the first parameter the destination class. Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public boolean` \| `[hasNext](#hasNext())()` \| \| \| `public static [Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html "Iterator")<[Node](https://docs.oracle.com/javase/8/docs/api/org/w3c/dom/Node.html "Node")>` \| `[iterator](#iterator(groovy.util.NodeList))([NodeList](../../../../../groovy/util/nodelist) nodeList)`Makes NodeList iterable by returning a read-only Iterator which traverses over each Node. \| \| \| `public [Node](../../../../../groovy/util/node)` \| `[next](#next())()` \| \| \| `public void` \| `[remove](#remove())()` \| \| \| `public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[serialize](#serialize(javax.swing.text.Element))([Element](https://docs.oracle.com/javase/8/docs/api/javax/swing/text/Element.html "Element") element)`Transforms the element to its text equivalent. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean hasNext() ### public static [Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html "Iterator")<[Node](https://docs.oracle.com/javase/8/docs/api/org/w3c/dom/Node.html "Node")> iterator([NodeList](../../../../../groovy/util/nodelist) nodeList) Makes NodeList iterable by returning a read-only Iterator which traverses over each Node. Parameters: `nodeList` - a NodeList Returns: an Iterator for a NodeList Since: 1.0 ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Node](../../../../../groovy/util/node) next() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void remove() ### public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") serialize([Element](https://docs.oracle.com/javase/8/docs/api/javax/swing/text/Element.html "Element") element) Transforms the element to its text equivalent. (The resulting string does not contain a xml declaration. Use `XmlUtil.serialize(element)` if you need the declaration.) Parameters: `element` - the element to serialize Returns: the string representation of the element Since: 2.1 groovy [Java] Class GroovyObjectHelper [Java] Class GroovyObjectHelper =============================== * org.apache.groovy.lang.GroovyObjectHelper ``` public class GroovyObjectHelper extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Helper for [GroovyObject](../../../../groovy/lang/groovyobject "GroovyObject") Since: 4.0.0 Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `protected [AtomicReference](https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/atomic/AtomicReference.html "AtomicReference")<Lookup>` \| `[computeValue](#computeValue(Class))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<?> type)` \| \| \| `public static [Optional](https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html "Optional")<Lookup>` \| `[lookup](#lookup(groovy.lang.GroovyObject))([GroovyObject](../../../../groovy/lang/groovyobject) groovyObject)`Get the Lookup instance of the [GroovyObject](../../../../groovy/lang/groovyobject "GroovyObject") instance \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected [AtomicReference](https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/atomic/AtomicReference.html "AtomicReference")<Lookup> computeValue([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<?> type) ### public static [Optional](https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html "Optional")<Lookup> lookup([GroovyObject](../../../../groovy/lang/groovyobject) groovyObject) Get the Lookup instance of the [GroovyObject](../../../../groovy/lang/groovyobject "GroovyObject") instance Parameters: `groovyObject` - the [GroovyObject](../../../../groovy/lang/groovyobject "GroovyObject") instance Returns: the Lookup instance Since: 4.0.0 groovy [Java] Annotation Type Incubating [Java] Annotation Type Incubating ================================= * org.apache.groovy.lang.annotation.Incubating ``` @[Documented](https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Documented.html "Documented") @[Retention](https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html "Retention")(value=RUNTIME) @[Target](https://docs.groovy-lang.org/docs/ant/api/org/apache/tools/ant/Target.html "Target")(value={TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, ANNOTATION_TYPE, PACKAGE}) public @interface Incubating ``` Annotation to indicate experimental and still to be refined API, which may change at any time Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| groovy [Java] Class DefaultFastStringService [Java] Class DefaultFastStringService ===================================== * org.apache.groovy.json.DefaultFastStringService All Implemented Interfaces and Traits: [FastStringService](faststringservice) ``` public class DefaultFastStringService extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") implements [FastStringService](faststringservice) ``` Internal class for fast processing of Strings during JSON parsing - default version Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[noCopyStringFromChars](#noCopyStringFromChars(char%5B%5D))(char[] chars)` \| \| \| `public char[]` \| `[toCharArray](#toCharArray(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") string)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") noCopyStringFromChars(char[] chars) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public char[] toCharArray([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") string) groovy [Java] Interface FastStringServiceFactory [Java] Interface FastStringServiceFactory ========================================= ``` public interface FastStringServiceFactory ``` Factory method to create the service. Should return null if the particular implementation isn't suitable because of the JDK environment (e.g. JVM version) or config settings otherwise disable the service. Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [FastStringService](faststringservice)` \| `[getService](#getService())()` \| Method Detail ------------- ### public [FastStringService](faststringservice) getService() groovy [Java] Class DefaultFastStringServiceFactory [Java] Class DefaultFastStringServiceFactory ============================================ * org.apache.groovy.json.DefaultFastStringServiceFactory All Implemented Interfaces and Traits: [FastStringServiceFactory](faststringservicefactory) ``` public class DefaultFastStringServiceFactory extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") implements [FastStringServiceFactory](faststringservicefactory) ``` Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [FastStringService](faststringservice)` \| `[getService](#getService())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [FastStringService](faststringservice) getService() groovy [Java] Interface FastStringService [Java] Interface FastStringService ================================== ``` public interface FastStringService ``` Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[noCopyStringFromChars](#noCopyStringFromChars(char%5B%5D))(char[] chars)` Parameters: `chars` - to shove array into. \| \| \| `public char[]` \| `[toCharArray](#toCharArray(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") string)` Parameters: `string` - string to grab array from. \| Method Detail ------------- ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") noCopyStringFromChars(char[] chars) Parameters: `chars` - to shove array into. Returns: new string with chars copied into it ### public char[] toCharArray([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") string) Parameters: `string` - string to grab array from. Returns: char array from string groovy [Java] Class FastStringUtils [Java] Class FastStringUtils ============================ * org.apache.groovy.json.internal.FastStringUtils ``` public class FastStringUtils extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Internal class for fast processing of Strings during JSON parsing Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[noCopyStringFromChars](#noCopyStringFromChars(char%5B%5D))(char[] chars)` Parameters: `chars` - to shove array into. \| \| \| `public static char[]` \| `[toCharArray](#toCharArray(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") string)` Parameters: `string` - string to grab array from. \| \| \| `public static char[]` \| `[toCharArray](#toCharArray(java.lang.CharSequence))([CharSequence](https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html "CharSequence") charSequence)` Parameters: `charSequence` - to grab array from. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") noCopyStringFromChars(char[] chars) Parameters: `chars` - to shove array into. Returns: new string with chars copied into it ### public static char[] toCharArray([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") string) Parameters: `string` - string to grab array from. Returns: char array from string ### public static char[] toCharArray([CharSequence](https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html "CharSequence") charSequence) Parameters: `charSequence` - to grab array from. Returns: char array from char sequence groovy [Java] Class ValueMapImpl [Java] Class ValueMapImpl ========================= * org.apache.groovy.json.internal.ValueMapImpl All Implemented Interfaces and Traits: [ValueMap](valuemap) ``` public class ValueMapImpl extends [AbstractMap](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html "AbstractMap") implements [ValueMap](valuemap) ``` This map is for object serialization mainly. The idea is the final conversion of the Value objects are delayed until the last possible moment, i.e., just before injected into a bean. Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public void` \| `[add](#add(org.apache.groovy.json.internal.MapItemValue))([MapItemValue](mapitemvalue) miv)` \| \| \| `public [Set](https://docs.oracle.com/javase/8/docs/api/java/util/Set.html "Set")<Entry<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Value](value "Value")>>` \| `[entrySet](#entrySet())()` \| \| \| `public [Value](value)` \| `[get](#get(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") key)` \| \| \| `public boolean` \| `[hydrated](#hydrated())()` \| \| \| `public Entry<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Value](value "Value")>[]` \| `[items](#items())()` \| \| \| `public int` \| `[len](#len())()` \| \| \| `public [Value](value)` \| `[put](#put(java.lang.String,%20org.apache.groovy.json.internal.Value))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") key, [Value](value) value)` \| \| \| `public int` \| `[size](#size())()`Return the size of the map. \| \| \| `public [Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection")<[Value](value "Value")>` \| `[values](#values())()`Return a collection of values. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractMap](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html "AbstractMap")` \| `[remove](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#remove(java.lang.Object) "remove"), [get](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#get(java.lang.Object) "get"), [put](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#put(java.lang.Object,%20java.lang.Object) "put"), [equals](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#toString() "toString"), [values](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#values() "values"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#hashCode() "hashCode"), [clear](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#clear() "clear"), [isEmpty](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#isEmpty() "isEmpty"), [size](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#size() "size"), [entrySet](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#entrySet() "entrySet"), [putAll](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#putAll(java.util.Map) "putAll"), [containsKey](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#containsKey(java.lang.Object) "containsKey"), [keySet](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#keySet() "keySet"), [containsValue](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#containsValue(java.lang.Object) "containsValue"), [wait](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#wait(long) "wait"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#notifyAll() "notifyAll"), [remove](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#remove(java.lang.Object,%20java.lang.Object) "remove"), [replace](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#replace(java.lang.Object,%20java.lang.Object) "replace"), [replace](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#replace(java.lang.Object,%20java.lang.Object,%20java.lang.Object) "replace"), [replaceAll](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#replaceAll(java.util.function.BiFunction) "replaceAll"), [merge](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#merge(java.lang.Object,%20java.lang.Object,%20java.util.function.BiFunction) "merge"), [putIfAbsent](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#putIfAbsent(java.lang.Object,%20java.lang.Object) "putIfAbsent"), [compute](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#compute(java.lang.Object,%20java.util.function.BiFunction) "compute"), [forEach](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#forEach(java.util.function.BiConsumer) "forEach"), [computeIfAbsent](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#computeIfAbsent(java.lang.Object,%20java.util.function.Function) "computeIfAbsent"), [getOrDefault](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#getOrDefault(java.lang.Object,%20java.lang.Object) "getOrDefault"), [computeIfPresent](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#computeIfPresent(java.lang.Object,%20java.util.function.BiFunction) "computeIfPresent")` \| Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void add([MapItemValue](mapitemvalue) miv) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Set](https://docs.oracle.com/javase/8/docs/api/java/util/Set.html "Set")<Entry<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Value](value "Value")>> entrySet() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Value](value) get([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") key) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean hydrated() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public Entry<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Value](value "Value")>[] items() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public int len() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Value](value) put([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") key, [Value](value) value) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public int size() Return the size of the map. Use the map if it has already been created. Returns: size ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection")<[Value](value "Value")> values() Return a collection of values.	programming_docs
groovy [Java] Class CharSequenceValue [Java] Class CharSequenceValue ============================== * org.apache.groovy.json.internal.CharSequenceValue All Implemented Interfaces and Traits: [Value](value), [CharSequence](https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html "CharSequence") ``` public class CharSequenceValue extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") implements [Value](value), [CharSequence](https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html "CharSequence") ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[CharSequenceValue](#CharSequenceValue(boolean,%20org.apache.groovy.json.internal.Type,%20int,%20int,%20char%5B%5D,%20boolean,%20boolean))(boolean chop, [Type](type) type, int startIndex, int endIndex, char[] buffer, boolean encoded, boolean checkDate)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [BigDecimal](https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html "BigDecimal")` \| `[bigDecimalValue](#bigDecimalValue())()` \| \| \| `public [BigInteger](https://docs.oracle.com/javase/8/docs/api/java/math/BigInteger.html "BigInteger")` \| `[bigIntegerValue](#bigIntegerValue())()` \| \| \| `public boolean` \| `[booleanValue](#booleanValue())()` \| \| \| `public byte` \| `[byteValue](#byteValue())()` \| \| \| `public final char` \| `[charAt](#charAt(int))(int index)` \| \| \| `public char` \| `[charValue](#charValue())()` \| \| \| `public final void` \| `[chop](#chop())()` \| \| \| `public [Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date")` \| `[dateValue](#dateValue())()` \| \| \| `public double` \| `[doubleValue](#doubleValue())()` \| \| \| `public boolean` \| `[equals](#equals(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o)` \| \| \| `public float` \| `[floatValue](#floatValue())()` \| \| \| `public int` \| `[hashCode](#hashCode())()` \| \| \| `public int` \| `[intValue](#intValue())()` \| \| \| `public boolean` \| `[isContainer](#isContainer())()` \| \| \| `public final int` \| `[length](#length())()` \| \| \| `public long` \| `[longValue](#longValue())()` \| \| \| `public short` \| `[shortValue](#shortValue())()` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[stringValue](#stringValue())()` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[stringValueEncoded](#stringValueEncoded())()` \| \| \| `public final [CharSequence](https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html "CharSequence")` \| `[subSequence](#subSequence(int,%20int))(int start, int end)` \| \| `<T extends Enum>` \| `public T` \| `[toEnum](#toEnum(Class))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<T> cls)` \| \| `<T extends Enum>` \| `public static T` \| `[toEnum](#toEnum(Class,%20java.lang.String))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<T> cls, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") value)` \| \| `<T extends Enum>` \| `public static T` \| `[toEnum](#toEnum(Class,%20int))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<T> cls, int value)` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[toString](#toString())()` \| \| \| `public final [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[toValue](#toValue())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public CharSequenceValue(boolean chop, [Type](type) type, int startIndex, int endIndex, char[] buffer, boolean encoded, boolean checkDate) Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [BigDecimal](https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html "BigDecimal") bigDecimalValue() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [BigInteger](https://docs.oracle.com/javase/8/docs/api/java/math/BigInteger.html "BigInteger") bigIntegerValue() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean booleanValue() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public byte byteValue() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public final char charAt(int index) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public char charValue() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public final void chop() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") dateValue() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public double doubleValue() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean equals([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public float floatValue() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public int hashCode() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public int intValue() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean isContainer() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public final int length() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public long longValue() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public short shortValue() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") stringValue() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") stringValueEncoded() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public final [CharSequence](https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html "CharSequence") subSequence(int start, int end) ### <T extends Enum> @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public T toEnum([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<T> cls) ### <T extends Enum> public static T toEnum([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<T> cls, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") value) ### <T extends Enum> public static T toEnum([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<T> cls, int value) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") toString() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public final [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") toValue() groovy [Java] Enum Type [Java] Enum Type ================ * org.apache.groovy.json.internal.Type ``` public enum Type extends [Enum](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html "Enum") ``` Enum Constants Summary ---------------------- Enum constants classes \| Enum constant \| Description \| \| `[DOUBLE](#DOUBLE)` \| \| \| `[FALSE](#FALSE)` \| \| \| `[INTEGER](#INTEGER)` \| \| \| `[LIST](#LIST)` \| \| \| `[MAP](#MAP)` \| \| \| `[NULL](#NULL)` \| \| \| `[STRING](#STRING)` \| \| \| `[TRUE](#TRUE)` \| \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Enum](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html "Enum")` \| `[name](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#name() "name"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#hashCode() "hashCode"), [compareTo](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#compareTo(java.lang.Object) "compareTo"), [compareTo](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#compareTo(java.lang.Enum) "compareTo"), [valueOf](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#valueOf(java.lang.Class,%20java.lang.String) "valueOf"), [describeConstable](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#describeConstable() "describeConstable"), [getDeclaringClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#getDeclaringClass() "getDeclaringClass"), [ordinal](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#ordinal() "ordinal"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#wait(long) "wait"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#notifyAll() "notifyAll")` \| Enum Constant Detail -------------------- ### public [Type](type) DOUBLE ### public [Type](type) FALSE ### public [Type](type) INTEGER ### public [Type](type) LIST ### public [Type](type) MAP ### public [Type](type) NULL ### public [Type](type) STRING ### public [Type](type) TRUE groovy [Java] Class SimpleCache<K, V> [Java] Class SimpleCache<K, V> ============================== * org.apache.groovy.json.internal.SimpleCache All Implemented Interfaces and Traits: [Cache](cache) ``` public class SimpleCache<K, V> extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") implements [Cache](cache) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[SimpleCache](#SimpleCache(int,%20org.apache.groovy.json.internal.CacheType))(int limit, [CacheType](cachetype) type)` \| \| `[SimpleCache](#SimpleCache(int))(int limit)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public V` \| `[get](#get(K))(K key)` \| \| \| `public V` \| `[getSilent](#getSilent(K))(K key)` \| \| \| `public void` \| `[put](#put(K,%20V))(K key, V value)` \| \| \| `public void` \| `[remove](#remove(K))(K key)` \| \| \| `public int` \| `[size](#size())()` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[toString](#toString())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public SimpleCache(int limit, [CacheType](cachetype) type) ### public SimpleCache(int limit) Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public V get(K key) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public V getSilent(K key) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void put(K key, V value) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void remove(K key) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public int size() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") toString() groovy [Java] Enum CacheType [Java] Enum CacheType ===================== * org.apache.groovy.json.internal.CacheType ``` public enum CacheType extends [Enum](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html "Enum") ``` Enum Constants Summary ---------------------- Enum constants classes \| Enum constant \| Description \| \| `[FIFO](#FIFO)` \| \| \| `[LFU](#LFU)` \| \| \| `[LRU](#LRU)` \| \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Enum](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html "Enum")` \| `[name](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#name() "name"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#hashCode() "hashCode"), [compareTo](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#compareTo(java.lang.Object) "compareTo"), [compareTo](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#compareTo(java.lang.Enum) "compareTo"), [valueOf](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#valueOf(java.lang.Class,%20java.lang.String) "valueOf"), [describeConstable](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#describeConstable() "describeConstable"), [getDeclaringClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#getDeclaringClass() "getDeclaringClass"), [ordinal](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#ordinal() "ordinal"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#wait(long) "wait"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#notifyAll() "notifyAll")` \| Enum Constant Detail -------------------- ### public [CacheType](cachetype) FIFO ### public [CacheType](cachetype) LFU ### public [CacheType](cachetype) LRU groovy [Java] Class ReaderCharacterSource [Java] Class ReaderCharacterSource ================================== * org.apache.groovy.json.internal.ReaderCharacterSource All Implemented Interfaces and Traits: [CharacterSource](charactersource) ``` public class ReaderCharacterSource extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") implements [CharacterSource](charactersource) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[ReaderCharacterSource](#ReaderCharacterSource(java.io.Reader,%20int))([Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") reader, int readAheadSize)` \| \| `[ReaderCharacterSource](#ReaderCharacterSource(java.io.Reader))([Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") reader)` \| \| `[ReaderCharacterSource](#ReaderCharacterSource(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") string)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public final boolean` \| `[consumeIfMatch](#consumeIfMatch(char%5B%5D))(char[] match)` \| \| \| `public final int` \| `[currentChar](#currentChar())()` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[errorDetails](#errorDetails(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message)` \| \| \| `public char[]` \| `[findNextChar](#findNextChar(int,%20int))(int match, int esc)` \| \| \| `public boolean` \| `[hadEscape](#hadEscape())()` \| \| \| `public final boolean` \| `[hasChar](#hasChar())()` \| \| \| `public final int` \| `[location](#location())()` \| \| \| `public final int` \| `[nextChar](#nextChar())()` \| \| \| `public char[]` \| `[readNumber](#readNumber())()` \| \| \| `public final int` \| `[safeNextChar](#safeNextChar())()` \| \| \| `public void` \| `[skipWhiteSpace](#skipWhiteSpace())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public ReaderCharacterSource([Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") reader, int readAheadSize) ### public ReaderCharacterSource([Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") reader) ### public ReaderCharacterSource([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") string) Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public final boolean consumeIfMatch(char[] match) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public final int currentChar() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") errorDetails([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public char[] findNextChar(int match, int esc) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean hadEscape() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public final boolean hasChar() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public final int location() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public final int nextChar() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public char[] readNumber() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public final int safeNextChar() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void skipWhiteSpace()	programming_docs
groovy [Java] Class JsonParserCharArray [Java] Class JsonParserCharArray ================================ * org.apache.groovy.json.internal.JsonParserCharArray ``` public class JsonParserCharArray extends [BaseJsonParser](basejsonparser) ``` Converts an input JSON String into Java objects works with String or char array as input. Produces an Object which can be any of the basic JSON types mapped to Java. Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `protected static char[]` \| `[FALSE](#FALSE)` \| \| \| `protected static char[]` \| `[NULL](#NULL)` \| \| \| `protected static char[]` \| `[TRUE](#TRUE)` \| \| \| `protected char` \| `[\_\_currentChar](#__currentChar)` \| \| \| `protected int` \| `[\_\_index](#__index)` \| \| \| `protected char[]` \| `[charArray](#charArray)` \| \| Inherited fields \| Fields inherited from class \| Fields \| \| `class [BaseJsonParser](basejsonparser)` \| `[ALPHA\_0](basejsonparser#ALPHA_0), [ALPHA\_1](basejsonparser#ALPHA_1), [ALPHA\_2](basejsonparser#ALPHA_2), [ALPHA\_3](basejsonparser#ALPHA_3), [ALPHA\_4](basejsonparser#ALPHA_4), [ALPHA\_5](basejsonparser#ALPHA_5), [ALPHA\_6](basejsonparser#ALPHA_6), [ALPHA\_7](basejsonparser#ALPHA_7), [ALPHA\_8](basejsonparser#ALPHA_8), [ALPHA\_9](basejsonparser#ALPHA_9), [CLOSED\_BRACKET](basejsonparser#CLOSED_BRACKET), [CLOSED\_CURLY](basejsonparser#CLOSED_CURLY), [COLON](basejsonparser#COLON), [COMMA](basejsonparser#COMMA), [DECIMAL\_POINT](basejsonparser#DECIMAL_POINT), [DOUBLE\_QUOTE](basejsonparser#DOUBLE_QUOTE), [ESCAPE](basejsonparser#ESCAPE), [LETTER\_BIG\_E](basejsonparser#LETTER_BIG_E), [LETTER\_E](basejsonparser#LETTER_E), [MINUS](basejsonparser#MINUS), [PLUS](basejsonparser#PLUS), [bufSize](basejsonparser#bufSize), [charset](basejsonparser#charset), [internKeys](basejsonparser#internKeys), [internedKeysCache](basejsonparser#internedKeysCache)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `protected final void` \| `[complain](#complain(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") complaint)` \| \| \| `protected final char` \| `[currentChar](#currentChar())()` \| \| \| `protected final boolean` \| `[decodeFalse](#decodeFalse())()` \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[decodeFromChars](#decodeFromChars(char%5B%5D))(char[] cs)` \| \| \| `protected final [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")` \| `[decodeJsonArray](#decodeJsonArray())()` \| \| \| `protected final [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[decodeJsonObject](#decodeJsonObject())()` \| \| \| `protected final [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[decodeNull](#decodeNull())()` \| \| \| `protected final boolean` \| `[decodeTrue](#decodeTrue())()` \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[decodeValue](#decodeValue())()` \| \| \| `protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[exceptionDetails](#exceptionDetails(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message)` \| \| \| `protected final boolean` \| `[hasCurrent](#hasCurrent())()` \| \| \| `protected final boolean` \| `[hasMore](#hasMore())()` \| \| \| `protected final char` \| `[nextChar](#nextChar())()` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[parse](#parse(char%5B%5D))(char[] chars)` \| \| \| `protected final void` \| `[skipWhiteSpace](#skipWhiteSpace())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [BaseJsonParser](basejsonparser)` \| `[charDescription](basejsonparser#charDescription(int)), [findEndQuote](basejsonparser#findEndQuote(char%5B%5D,%20int)), [hasEscapeChar](basejsonparser#hasEscapeChar(char%5B%5D,%20int,%20int%5B%5D)), [isDecimalChar](basejsonparser#isDecimalChar(int)), [isDelimiter](basejsonparser#isDelimiter(int)), [isDoubleQuote](basejsonparser#isDoubleQuote(int)), [isEscape](basejsonparser#isEscape(int)), [isNumberDigit](basejsonparser#isNumberDigit(int)), [parse](basejsonparser#parse(java.lang.String)), [parse](basejsonparser#parse(byte%5B%5D)), [parse](basejsonparser#parse(byte%5B%5D,%20java.lang.String)), [parse](basejsonparser#parse(java.lang.CharSequence)), [parse](basejsonparser#parse(java.io.Reader)), [parse](basejsonparser#parse(java.io.InputStream)), [parse](basejsonparser#parse(java.io.InputStream,%20java.lang.String)), [parse](basejsonparser#parse(java.io.File,%20java.lang.String)), [setCharset](basejsonparser#setCharset(java.lang.String))` \| Field Detail ------------ ### protected static char[] FALSE ### protected static final char[] NULL ### protected static final char[] TRUE ### protected char \_\_currentChar ### protected int \_\_index ### protected char[] charArray Method Detail ------------- ### protected final void complain([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") complaint) ### protected final char currentChar() ### protected final boolean decodeFalse() ### protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") decodeFromChars(char[] cs) ### protected final [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") decodeJsonArray() ### protected final [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") decodeJsonObject() ### protected final [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") decodeNull() ### protected final boolean decodeTrue() ### protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") decodeValue() ### protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") exceptionDetails([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message) ### protected final boolean hasCurrent() ### protected final boolean hasMore() ### protected final char nextChar() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parse(char[] chars) ### protected final void skipWhiteSpace() groovy [Java] Class IO [Java] Class IO =============== * org.apache.groovy.json.internal.IO ``` public class IO extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public static int` \| `[copy](#copy(java.io.Reader,%20java.io.Writer))([Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") input, [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") output)` \| \| \| `public static long` \| `[copyLarge](#copyLarge(java.io.Reader,%20java.io.Writer))([Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") reader, [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") writer)` \| \| \| `public static long` \| `[copyLarge](#copyLarge(java.io.Reader,%20java.io.Writer,%20char%5B%5D))([Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") reader, [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") writer, char[] buffer)` \| \| \| `public static [CharBuf](charbuf)` \| `[read](#read(java.io.Reader,%20org.apache.groovy.json.internal.CharBuf,%20int))([Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") input, [CharBuf](charbuf) charBuf, int bufSize)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### public static int copy([Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") input, [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") output) ### public static long copyLarge([Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") reader, [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") writer) ### public static long copyLarge([Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") reader, [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") writer, char[] buffer) ### public static [CharBuf](charbuf) read([Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") input, [CharBuf](charbuf) charBuf, int bufSize) groovy [Java] Class CharBuf [Java] Class CharBuf ==================== * org.apache.groovy.json.internal.CharBuf All Implemented Interfaces and Traits: [CharSequence](https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html "CharSequence") ``` public class CharBuf extends [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") implements [CharSequence](https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html "CharSequence") ``` Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `protected char[]` \| `[buffer](#buffer)` \| \| \| `protected int` \| `[capacity](#capacity)` \| \| \| `protected int` \| `[location](#location)` \| \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[CharBuf](#CharBuf(char%5B%5D))(char[] buffer)` \| \| `[CharBuf](#CharBuf(byte%5B%5D))(byte[] bytes)` \| \| `protected [CharBuf](#CharBuf(int))(int capacity)` \| \| `protected [CharBuf](#CharBuf())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public void` \| `[\_len](#_len(int))(int location)` \| \| \| `public [CharBuf](charbuf)` \| `[add](#add(char%5B%5D))(char[] chars)` \| \| \| `public final [CharBuf](charbuf)` \| `[add](#add(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") str)` \| \| \| `public final [CharBuf](charbuf)` \| `[add](#add(int))(int i)` \| \| \| `public final [CharBuf](charbuf)` \| `[add](#add(boolean))(boolean b)` \| \| \| `public final [CharBuf](charbuf)` \| `[add](#add(byte))(byte i)` \| \| \| `public final [CharBuf](charbuf)` \| `[add](#add(short))(short i)` \| \| \| `public final [CharBuf](charbuf)` \| `[add](#add(long))(long l)` \| \| \| `public final [CharBuf](charbuf)` \| `[add](#add(double))(double d)` \| \| \| `public final [CharBuf](charbuf)` \| `[add](#add(float))(float d)` \| \| \| `public [CharBuf](charbuf)` \| `[add](#add(char%5B%5D))(char[] chars)` \| \| \| `public [CharBuf](charbuf)` \| `[add](#add(char%5B%5D,%20int))(char[] chars, int length)` \| \| \| `public [CharBuf](charbuf)` \| `[add](#add(byte%5B%5D))(byte[] chars)` \| \| \| `public [CharBuf](charbuf)` \| `[add](#add(byte%5B%5D,%20int,%20int))(byte[] bytes, int start, int end)` \| \| \| `public final [CharBuf](charbuf)` \| `[add](#add(char))(char ch)` \| \| \| `public [CharBuf](charbuf)` \| `[addBigDecimal](#addBigDecimal(java.math.BigDecimal))([BigDecimal](https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html "BigDecimal") key)` \| \| \| `public [CharBuf](charbuf)` \| `[addBigInteger](#addBigInteger(java.math.BigInteger))([BigInteger](https://docs.oracle.com/javase/8/docs/api/java/math/BigInteger.html "BigInteger") key)` \| \| \| `public final [CharBuf](charbuf)` \| `[addBoolean](#addBoolean(boolean))(boolean b)` \| \| \| `public final [CharBuf](charbuf)` \| `[addByte](#addByte(byte))(byte i)` \| \| \| `public final [CharBuf](charbuf)` \| `[addChar](#addChar(byte))(byte i)` \| \| \| `public final [CharBuf](charbuf)` \| `[addChar](#addChar(int))(int i)` \| \| \| `public final [CharBuf](charbuf)` \| `[addChar](#addChar(short))(short i)` \| \| \| `public final [CharBuf](charbuf)` \| `[addChar](#addChar(char))(char ch)` \| \| \| `public final [CharBuf](charbuf)` \| `[addChars](#addChars(char%5B%5D))(char[] chars)` \| \| \| `public final [CharBuf](charbuf)` \| `[addDouble](#addDouble(double))(double d)` \| \| \| `public final [CharBuf](charbuf)` \| `[addDouble](#addDouble(java.lang.Double))([Double](https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html "Double") key)` \| \| \| `public final [CharBuf](charbuf)` \| `[addFloat](#addFloat(float))(float d)` \| \| \| `public final [CharBuf](charbuf)` \| `[addFloat](#addFloat(java.lang.Float))([Float](https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html "Float") key)` \| \| \| `public final [CharBuf](charbuf)` \| `[addInt](#addInt(int))(int i)` \| \| \| `public final [CharBuf](charbuf)` \| `[addInt](#addInt(java.lang.Integer))([Integer](https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html "Integer") key)` \| \| \| `public final [CharBuf](charbuf)` \| `[addJsonEscapedString](#addJsonEscapedString(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") jsonString)` \| \| \| `public final [CharBuf](charbuf)` \| `[addJsonEscapedString](#addJsonEscapedString(java.lang.String,%20boolean))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") jsonString, boolean disableUnicodeEscaping)` \| \| \| `public final [CharBuf](charbuf)` \| `[addJsonEscapedString](#addJsonEscapedString(char%5B%5D))(char[] charArray)` \| \| \| `public final [CharBuf](charbuf)` \| `[addJsonEscapedString](#addJsonEscapedString(char%5B%5D,%20boolean))(char[] charArray, boolean disableUnicodeEscaping)` \| \| \| `public final [CharBuf](charbuf)` \| `[addJsonFieldName](#addJsonFieldName(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") str)` \| \| \| `public final [CharBuf](charbuf)` \| `[addJsonFieldName](#addJsonFieldName(java.lang.String,%20boolean))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") str, boolean disableUnicodeEscaping)` \| \| \| `public final [CharBuf](charbuf)` \| `[addJsonFieldName](#addJsonFieldName(char%5B%5D))(char[] chars)` \| \| \| `public final [CharBuf](charbuf)` \| `[addJsonFieldName](#addJsonFieldName(char%5B%5D,%20boolean))(char[] chars, boolean disableUnicodeEscaping)` \| \| \| `public [CharBuf](charbuf)` \| `[addLine](#addLine(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") str)` \| \| \| `public [CharBuf](charbuf)` \| `[addLine](#addLine(java.lang.CharSequence))([CharSequence](https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html "CharSequence") str)` \| \| \| `public final [CharBuf](charbuf)` \| `[addLong](#addLong(long))(long l)` \| \| \| `public final [CharBuf](charbuf)` \| `[addLong](#addLong(java.lang.Long))([Long](https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html "Long") key)` \| \| \| `public final void` \| `[addNull](#addNull())()` \| \| \| `public final [CharBuf](charbuf)` \| `[addQuoted](#addQuoted(char%5B%5D))(char[] chars)` \| \| \| `public final [CharBuf](charbuf)` \| `[addQuoted](#addQuoted(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") str)` \| \| \| `public final [CharBuf](charbuf)` \| `[addShort](#addShort(short))(short i)` \| \| \| `public final [CharBuf](charbuf)` \| `[addString](#addString(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") str)` \| \| \| `public byte` \| `[byteValue](#byteValue())()` \| \| \| `public char` \| `[charAt](#charAt(int))(int index)` \| \| \| `public void` \| `[close](#close())()` \| \| \| `public static [CharBuf](charbuf)` \| `[create](#create(int))(int capacity)` \| \| \| `public static [CharBuf](charbuf)` \| `[create](#create(char%5B%5D))(char[] buffer)` \| \| \| `public static [CharBuf](charbuf)` \| `[createExact](#createExact(int))(int capacity)` \| \| \| `public final [CharBuf](charbuf)` \| `[decodeJsonString](#decodeJsonString(char%5B%5D))(char[] chars)` \| \| \| `public final [CharBuf](charbuf)` \| `[decodeJsonString](#decodeJsonString(char%5B%5D,%20int,%20int))(char[] chars, int start, int to)` \| \| \| `public double` \| `[doubleValue](#doubleValue())()` \| \| \| `public float` \| `[floatValue](#floatValue())()` \| \| \| `public void` \| `[flush](#flush())()` \| \| \| `public void` \| `[init](#init())()` \| \| \| `public int` \| `[intValue](#intValue())()` \| \| \| `public int` \| `[len](#len())()` \| \| \| `public int` \| `[length](#length())()` \| \| \| `public long` \| `[longValue](#longValue())()` \| \| \| `public char[]` \| `[readForRecycle](#readForRecycle())()` \| \| \| `public void` \| `[recycle](#recycle())()` \| \| \| `public void` \| `[removeLastChar](#removeLastChar())()` \| \| \| `public void` \| `[removeLastChar](#removeLastChar(char))(char expect)` \| \| \| `public short` \| `[shortValue](#shortValue())()` \| \| \| `public [CharSequence](https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html "CharSequence")` \| `[subSequence](#subSequence(int,%20int))(int start, int end)` \| \| \| `public char[]` \| `[toCharArray](#toCharArray())()` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[toDebugString](#toDebugString())()` \| \| \| `public [Number](https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html "Number")` \| `[toIntegerWrapper](#toIntegerWrapper())()` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[toString](#toString())()` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[toStringAndRecycle](#toStringAndRecycle())()` \| \| \| `public void` \| `[write](#write(char%5B%5D,%20int,%20int))(char[] cbuf, int off, int len)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer")` \| `[append](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#append(java.lang.CharSequence,%20int,%20int) "append"), [append](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#append(java.lang.CharSequence,%20int,%20int) "append"), [append](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#append(char) "append"), [append](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#append(char) "append"), [append](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#append(java.lang.CharSequence) "append"), [append](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#append(java.lang.CharSequence) "append"), [flush](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#flush() "flush"), [write](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#write(java.lang.String,%20int,%20int) "write"), [write](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#write(int) "write"), [write](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#write(java.lang.String) "write"), [write](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#write(%5BC,%20int,%20int) "write"), [write](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#write(%5BC) "write"), [close](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#close() "close"), [nullWriter](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#nullWriter() "nullWriter"), [wait](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#notifyAll() "notifyAll")` \| Field Detail ------------ ### protected char[] buffer ### protected int capacity ### protected int location Constructor Detail ------------------ ### public CharBuf(char[] buffer) ### public CharBuf(byte[] bytes) ### protected CharBuf(int capacity) ### protected CharBuf() Method Detail ------------- ### public void \_len(int location) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [CharBuf](charbuf) add(char[] chars) ### public final [CharBuf](charbuf) add([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") str) ### public final [CharBuf](charbuf) add(int i) ### public final [CharBuf](charbuf) add(boolean b) ### public final [CharBuf](charbuf) add(byte i) ### public final [CharBuf](charbuf) add(short i) ### public final [CharBuf](charbuf) add(long l) ### public final [CharBuf](charbuf) add(double d) ### public final [CharBuf](charbuf) add(float d) ### public [CharBuf](charbuf) add(char[] chars) ### public [CharBuf](charbuf) add(char[] chars, int length) ### public [CharBuf](charbuf) add(byte[] chars) ### public [CharBuf](charbuf) add(byte[] bytes, int start, int end) ### public final [CharBuf](charbuf) add(char ch) ### public [CharBuf](charbuf) addBigDecimal([BigDecimal](https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html "BigDecimal") key) ### public [CharBuf](charbuf) addBigInteger([BigInteger](https://docs.oracle.com/javase/8/docs/api/java/math/BigInteger.html "BigInteger") key) ### public final [CharBuf](charbuf) addBoolean(boolean b) ### public final [CharBuf](charbuf) addByte(byte i) ### public final [CharBuf](charbuf) addChar(byte i) ### public final [CharBuf](charbuf) addChar(int i) ### public final [CharBuf](charbuf) addChar(short i) ### public final [CharBuf](charbuf) addChar(char ch) ### public final [CharBuf](charbuf) addChars(char[] chars) ### public final [CharBuf](charbuf) addDouble(double d) ### public final [CharBuf](charbuf) addDouble([Double](https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html "Double") key) ### public final [CharBuf](charbuf) addFloat(float d) ### public final [CharBuf](charbuf) addFloat([Float](https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html "Float") key) ### public final [CharBuf](charbuf) addInt(int i) ### public final [CharBuf](charbuf) addInt([Integer](https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html "Integer") key) ### public final [CharBuf](charbuf) addJsonEscapedString([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") jsonString) ### public final [CharBuf](charbuf) addJsonEscapedString([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") jsonString, boolean disableUnicodeEscaping) ### public final [CharBuf](charbuf) addJsonEscapedString(char[] charArray) ### public final [CharBuf](charbuf) addJsonEscapedString(char[] charArray, boolean disableUnicodeEscaping) ### public final [CharBuf](charbuf) addJsonFieldName([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") str) ### public final [CharBuf](charbuf) addJsonFieldName([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") str, boolean disableUnicodeEscaping) ### public final [CharBuf](charbuf) addJsonFieldName(char[] chars) ### public final [CharBuf](charbuf) addJsonFieldName(char[] chars, boolean disableUnicodeEscaping) ### public [CharBuf](charbuf) addLine([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") str) ### public [CharBuf](charbuf) addLine([CharSequence](https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html "CharSequence") str) ### public final [CharBuf](charbuf) addLong(long l) ### public final [CharBuf](charbuf) addLong([Long](https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html "Long") key) ### public final void addNull() ### public final [CharBuf](charbuf) addQuoted(char[] chars) ### public final [CharBuf](charbuf) addQuoted([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") str) ### public final [CharBuf](charbuf) addShort(short i) ### public final [CharBuf](charbuf) addString([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") str) ### public byte byteValue() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public char charAt(int index) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void close() ### public static [CharBuf](charbuf) create(int capacity) ### public static [CharBuf](charbuf) create(char[] buffer) ### public static [CharBuf](charbuf) createExact(int capacity) ### public final [CharBuf](charbuf) decodeJsonString(char[] chars) ### public final [CharBuf](charbuf) decodeJsonString(char[] chars, int start, int to) ### public double doubleValue() ### public float floatValue() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void flush() ### public void init() ### public int intValue() ### public int len() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public int length() ### public long longValue() ### public char[] readForRecycle() ### public void recycle() ### public void removeLastChar() ### public void removeLastChar(char expect) ### public short shortValue() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [CharSequence](https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html "CharSequence") subSequence(int start, int end) ### public char[] toCharArray() ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") toDebugString() ### public [Number](https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html "Number") toIntegerWrapper() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") toString() ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") toStringAndRecycle() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void write(char[] cbuf, int off, int len)	programming_docs
groovy [Java] Class ArrayUtils [Java] Class ArrayUtils ======================= * org.apache.groovy.json.internal.ArrayUtils ``` public class ArrayUtils extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public static char[]` \| `[copyRange](#copyRange(char%5B%5D,%20int,%20int))(char[] source, int startIndex, int endIndex)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### public static char[] copyRange(char[] source, int startIndex, int endIndex) groovy [Java] Interface Cache<KEY, VALUE> [Java] Interface Cache<KEY, VALUE> ================================== ``` public interface Cache<KEY, VALUE> ``` Cache Type Parameters: `KEY` - key `VALUE` - value Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [VALUE](../../../../../value)` \| `[get](#get(KEY))([KEY](../../../../../key) key)` \| \| \| `public [VALUE](../../../../../value)` \| `[getSilent](#getSilent(KEY))([KEY](../../../../../key) key)` \| \| \| `public void` \| `[put](#put(KEY,%20VALUE))([KEY](../../../../../key) key, [VALUE](../../../../../value) value)` \| \| \| `public void` \| `[remove](#remove(KEY))([KEY](../../../../../key) key)` \| \| \| `public int` \| `[size](#size())()` \| Method Detail ------------- ### public [VALUE](../../../../../value) get([KEY](../../../../../key) key) ### public [VALUE](../../../../../value) getSilent([KEY](../../../../../key) key) ### public void put([KEY](../../../../../key) key, [VALUE](../../../../../value) value) ### public void remove([KEY](../../../../../key) key) ### public int size() groovy [Java] Class JsonParserUsingCharacterSource [Java] Class JsonParserUsingCharacterSource =========================================== * org.apache.groovy.json.internal.JsonParserUsingCharacterSource ``` public class JsonParserUsingCharacterSource extends [BaseJsonParser](basejsonparser) ``` Converts an input JSON String into Java objects works with String or char array as input. Produces an Object which can be any of the basic JSON types mapped to Java. Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `protected static char[]` \| `[FALSE](#FALSE)` \| \| \| `protected static char[]` \| `[NULL](#NULL)` \| \| \| `protected static char[]` \| `[TRUE](#TRUE)` \| \| Inherited fields \| Fields inherited from class \| Fields \| \| `class [BaseJsonParser](basejsonparser)` \| `[ALPHA\_0](basejsonparser#ALPHA_0), [ALPHA\_1](basejsonparser#ALPHA_1), [ALPHA\_2](basejsonparser#ALPHA_2), [ALPHA\_3](basejsonparser#ALPHA_3), [ALPHA\_4](basejsonparser#ALPHA_4), [ALPHA\_5](basejsonparser#ALPHA_5), [ALPHA\_6](basejsonparser#ALPHA_6), [ALPHA\_7](basejsonparser#ALPHA_7), [ALPHA\_8](basejsonparser#ALPHA_8), [ALPHA\_9](basejsonparser#ALPHA_9), [CLOSED\_BRACKET](basejsonparser#CLOSED_BRACKET), [CLOSED\_CURLY](basejsonparser#CLOSED_CURLY), [COLON](basejsonparser#COLON), [COMMA](basejsonparser#COMMA), [DECIMAL\_POINT](basejsonparser#DECIMAL_POINT), [DOUBLE\_QUOTE](basejsonparser#DOUBLE_QUOTE), [ESCAPE](basejsonparser#ESCAPE), [LETTER\_BIG\_E](basejsonparser#LETTER_BIG_E), [LETTER\_E](basejsonparser#LETTER_E), [MINUS](basejsonparser#MINUS), [PLUS](basejsonparser#PLUS), [bufSize](basejsonparser#bufSize), [charset](basejsonparser#charset), [internKeys](basejsonparser#internKeys), [internedKeysCache](basejsonparser#internedKeysCache)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `protected final void` \| `[complain](#complain(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") complaint)` \| \| \| `protected final boolean` \| `[decodeFalse](#decodeFalse())()` \| \| \| `protected final [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")` \| `[decodeJsonArray](#decodeJsonArray())()` \| \| \| `protected final [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[decodeJsonObject](#decodeJsonObject())()` \| \| \| `protected final [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[decodeNull](#decodeNull())()` \| \| \| `protected final boolean` \| `[decodeTrue](#decodeTrue())()` \| \| \| `protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[exceptionDetails](#exceptionDetails(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message)` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[parse](#parse(java.io.Reader))([Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") reader)` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[parse](#parse(char%5B%5D))(char[] chars)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [BaseJsonParser](basejsonparser)` \| `[charDescription](basejsonparser#charDescription(int)), [findEndQuote](basejsonparser#findEndQuote(char%5B%5D,%20int)), [hasEscapeChar](basejsonparser#hasEscapeChar(char%5B%5D,%20int,%20int%5B%5D)), [isDecimalChar](basejsonparser#isDecimalChar(int)), [isDelimiter](basejsonparser#isDelimiter(int)), [isDoubleQuote](basejsonparser#isDoubleQuote(int)), [isEscape](basejsonparser#isEscape(int)), [isNumberDigit](basejsonparser#isNumberDigit(int)), [parse](basejsonparser#parse(java.lang.String)), [parse](basejsonparser#parse(byte%5B%5D)), [parse](basejsonparser#parse(byte%5B%5D,%20java.lang.String)), [parse](basejsonparser#parse(java.lang.CharSequence)), [parse](basejsonparser#parse(java.io.Reader)), [parse](basejsonparser#parse(java.io.InputStream)), [parse](basejsonparser#parse(java.io.InputStream,%20java.lang.String)), [parse](basejsonparser#parse(java.io.File,%20java.lang.String)), [setCharset](basejsonparser#setCharset(java.lang.String))` \| Field Detail ------------ ### protected static char[] FALSE ### protected static final char[] NULL ### protected static final char[] TRUE Method Detail ------------- ### protected final void complain([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") complaint) ### protected final boolean decodeFalse() ### protected final [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") decodeJsonArray() ### protected final [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") decodeJsonObject() ### protected final [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") decodeNull() ### protected final boolean decodeTrue() ### protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") exceptionDetails([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parse([Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") reader) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parse(char[] chars) groovy [Java] Interface CharacterSource [Java] Interface CharacterSource ================================ ``` public interface CharacterSource ``` Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public boolean` \| `[consumeIfMatch](#consumeIfMatch(char%5B%5D))(char[] match)`Useful for finding constants in a string like true, false, etc. \| \| \| `public int` \| `[currentChar](#currentChar())()`returns the current character without changing the IO pointer or index. \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[errorDetails](#errorDetails(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message)` \| \| \| `public char[]` \| `[findNextChar](#findNextChar(int,%20int))(int ch, int esc)`Used to find strings and their ilk Finds the next non-escaped char \| \| \| `public boolean` \| `[hadEscape](#hadEscape())()` \| \| \| `public boolean` \| `[hasChar](#hasChar())()`Checks to see if there is a next character. \| \| \| `public int` \| `[location](#location())()`This is mostly for debugging and testing. \| \| \| `public int` \| `[nextChar](#nextChar())()`returns the next character moving the file pointer or index to the next location. \| \| \| `public char[]` \| `[readNumber](#readNumber())()`Reads a number from the character source. \| \| \| `public int` \| `[safeNextChar](#safeNextChar())()`Combines the operations of nextChar and hasChar. \| \| \| `public void` \| `[skipWhiteSpace](#skipWhiteSpace())()`Skip white space. \| Method Detail ------------- ### public boolean consumeIfMatch(char[] match) Useful for finding constants in a string like true, false, etc. ### public int currentChar() returns the current character without changing the IO pointer or index. ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") errorDetails([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message) ### public char[] findNextChar(int ch, int esc) Used to find strings and their ilk Finds the next non-escaped char Parameters: `ch` - character to find `esc` - escape character to avoid next char if escaped Returns: list of chars until this is found. ### public boolean hadEscape() ### public boolean hasChar() Checks to see if there is a next character. ### public int location() This is mostly for debugging and testing. ### public int nextChar() returns the next character moving the file pointer or index to the next location. ### public char[] readNumber() Reads a number from the character source. ### public int safeNextChar() Combines the operations of nextChar and hasChar. Characters is -1 if not found which signifies end of file. This might be preferable to avoid two method calls. ### public void skipWhiteSpace() Skip white space. groovy [Java] Class ByteScanner [Java] Class ByteScanner ======================== * org.apache.groovy.json.internal.ByteScanner ``` public class ByteScanner extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public static void` \| `[encodeByteIntoTwoAsciiCharBytes](#encodeByteIntoTwoAsciiCharBytes(int,%20byte%5B%5D))(int decoded, byte[] encoded)`Turn a single bytes into two hex character representation. \| \| \| `protected static int` \| `[encodeNibbleToHexAsciiCharByte](#encodeNibbleToHexAsciiCharByte(int))(int nibble)`Turns a single nibble into an ascii HEX digit. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### public static void encodeByteIntoTwoAsciiCharBytes(int decoded, byte[] encoded) Turn a single bytes into two hex character representation. Parameters: `decoded` - the byte to serializeObject. `encoded` - the array to which each encoded nibbles are now ascii hex representations. ### protected static int encodeNibbleToHexAsciiCharByte(int nibble) Turns a single nibble into an ascii HEX digit. Parameters: `nibble` - the nibble to serializeObject. Returns: the encoded nibble (1/2 byte). groovy [Java] Class MapItemValue [Java] Class MapItemValue ========================= * org.apache.groovy.json.internal.MapItemValue All Implemented Interfaces and Traits: [MapEntry](../../../../../groovy/util/mapentry) ``` public class MapItemValue extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") implements [MapEntry](../../../../../groovy/util/mapentry) ``` This holds a mapping from value key to value value to maximize laziness. Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `protected static [ConcurrentHashMap](https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ConcurrentHashMap.html "ConcurrentHashMap")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>` \| `[internedKeysCache](#internedKeysCache)` \| \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[MapItemValue](#MapItemValue(org.apache.groovy.json.internal.Value,%20org.apache.groovy.json.internal.Value))([Value](value) name, [Value](value) value)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getKey](#getKey())()` \| \| \| `public [Value](value)` \| `[getValue](#getValue())()` \| \| \| `public [Value](value)` \| `[setValue](#setValue(org.apache.groovy.json.internal.Value))([Value](value) value)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Field Detail ------------ ### protected static final [ConcurrentHashMap](https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ConcurrentHashMap.html "ConcurrentHashMap")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> internedKeysCache Constructor Detail ------------------ ### public MapItemValue([Value](value) name, [Value](value) value) Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getKey() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Value](value) getValue() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Value](value) setValue([Value](value) value) groovy [Java] Class Chr [Java] Class Chr ================ * org.apache.groovy.json.internal.Chr ``` public class Chr extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public static void` \| `[\_idx](#_idx(char%5B%5D,%20int,%20byte%5B%5D))(char[] buffer, int location, byte[] chars)` \| \| \| `public static void` \| `[\_idx](#_idx(char%5B%5D,%20int,%20char%5B%5D))(char[] array, int startIndex, char[] input)` \| \| \| `public static void` \| `[\_idx](#_idx(char%5B%5D,%20int,%20char%5B%5D,%20int))(char[] array, int startIndex, char[] input, int inputLength)` \| \| \| `public static void` \| `[\_idx](#_idx(char%5B%5D,%20int,%20byte%5B%5D,%20int,%20int))(char[] buffer, int location, byte[] chars, int start, int end)` \| \| \| `public static char[]` \| `[add](#add(char%5B%5D,%20char))(char[] array, char v)` \| \| \| `public static char[]` \| `[add](#add(char%5B%5D,%20java.lang.String))(char[] array, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") str)` \| \| \| `public static char[]` \| `[add](#add(char%5B%5D,%20java.lang.StringBuilder))(char[] array, [StringBuilder](https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html "StringBuilder") stringBuilder)` \| \| \| `public static char[]` \| `[add](#add(char%5B%5D,%20char%5B%5D))(char[] array, char[] array2)` \| \| \| `public static char[]` \| `[add](#add(char%5B%5D))(char[] strings)` \| \| \| `public static char[]` \| `[array](#array(char))(char array)` \| \| \| `public static char[]` \| `[chars](#chars(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") array)` \| \| \| `public static boolean` \| `[contains](#contains(char%5B%5D,%20char,%20int,%20int))(char[] chars, char c, int start, int length)` \| \| \| `public static char[]` \| `[copy](#copy(char%5B%5D))(char[] array)` \| \| \| `public static char[]` \| `[copy](#copy(char%5B%5D,%20int,%20int))(char[] array, int offset, int length)` \| \| \| `public static char[]` \| `[grow](#grow(char%5B%5D,%20int))(char[] array, int size)` \| \| \| `public static char[]` \| `[grow](#grow(char%5B%5D))(char[] array)` \| \| \| `public static boolean` \| `[in](#in(char,%20char%5B%5D))(char value, char[] array)` \| \| \| `public static boolean` \| `[in](#in(int,%20char%5B%5D))(int value, char[] array)` \| \| \| `public static boolean` \| `[in](#in(char,%20int,%20char%5B%5D))(char value, int offset, char[] array)` \| \| \| `public static boolean` \| `[in](#in(char,%20int,%20int,%20char%5B%5D))(char value, int offset, int end, char[] array)` \| \| \| `public static char[]` \| `[lpad](#lpad(char%5B%5D,%20int,%20char))(char[] in, int size, char pad)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### public static void \_idx(char[] buffer, int location, byte[] chars) ### public static void \_idx(char[] array, int startIndex, char[] input) ### public static void \_idx(char[] array, int startIndex, char[] input, int inputLength) ### public static void \_idx(char[] buffer, int location, byte[] chars, int start, int end) ### public static char[] add(char[] array, char v) ### public static char[] add(char[] array, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") str) ### public static char[] add(char[] array, [StringBuilder](https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html "StringBuilder") stringBuilder) ### public static char[] add(char[] array, char[] array2) ### public static char[] add(char[] strings) ### public static char[] array(char array) ### public static char[] chars([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") array) ### public static boolean contains(char[] chars, char c, int start, int length) ### public static char[] copy(char[] array) ### public static char[] copy(char[] array, int offset, int length) ### public static char[] grow(char[] array, int size) ### public static char[] grow(char[] array) ### public static boolean in(char value, char[] array) ### public static boolean in(int value, char[] array) ### public static boolean in(char value, int offset, char[] array) ### public static boolean in(char value, int offset, int end, char[] array) ### public static char[] lpad(char[] in, int size, char pad)	programming_docs
groovy [Java] Class Exceptions [Java] Class Exceptions ======================= * org.apache.groovy.json.internal.Exceptions ``` public class Exceptions extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Nested Class Summary -------------------- Nested classes \| Modifiers \| Name \| Description \| \| `static class` \| `[Exceptions.JsonInternalException](exceptions.jsoninternalexception)` \| \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public static boolean` \| `[die](#die())()` \| \| \| `public static boolean` \| `[die](#die(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message)` \| \| `<T>` \| `public static T` \| `[die](#die(Class,%20java.lang.String))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<T> clazz, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message)` \| \| \| `public static void` \| `[handle](#handle(java.lang.Exception))([Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html "Exception") e)` \| \| `<T>` \| `public static T` \| `[handle](#handle(Class,%20java.lang.Exception))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<T> clazz, [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html "Exception") e)` \| \| `<T>` \| `public static T` \| `[handle](#handle(Class,%20java.lang.String,%20java.lang.Throwable))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<T> clazz, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message, [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html "Throwable") e)` \| \| \| `public static void` \| `[handle](#handle(java.lang.String,%20java.lang.Throwable))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message, [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html "Throwable") e)` \| \| \| `public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[sputs](#sputs(org.apache.groovy.json.internal.CharBuf,%20java.lang.Object))([CharBuf](charbuf) buf, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") messages)` \| \| \| `public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[sputs](#sputs(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") messages)` \| \| \| `public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[toString](#toString(java.lang.Exception))([Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html "Exception") ex)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### public static boolean die() ### public static boolean die([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message) ### <T> public static T die([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<T> clazz, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message) ### public static void handle([Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html "Exception") e) ### <T> public static T handle([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<T> clazz, [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html "Exception") e) ### <T> public static T handle([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<T> clazz, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message, [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html "Throwable") e) ### public static void handle([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message, [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html "Throwable") e) ### public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") sputs([CharBuf](charbuf) buf, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") messages) ### public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") sputs([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") messages) ### public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") toString([Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html "Exception") ex) groovy [Java] Class Exceptions.JsonInternalException [Java] Class Exceptions.JsonInternalException ============================================= * org.apache.groovy.json.internal.Exceptions.JsonInternalException ``` public static class Exceptions.JsonInternalException extends [JsonException](../../../../../groovy/json/jsonexception) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[JsonInternalException](#JsonInternalException(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message)` \| \| `[JsonInternalException](#JsonInternalException(java.lang.String,%20java.lang.Throwable))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message, [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html "Throwable") cause)` \| \| `[JsonInternalException](#JsonInternalException(java.lang.Throwable))([Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html "Throwable") cause)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html "Throwable")` \| `[getCause](#getCause())()` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getLocalizedMessage](#getLocalizedMessage())()` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getMessage](#getMessage())()` \| \| \| `public [StackTraceElement](https://docs.oracle.com/javase/8/docs/api/java/lang/StackTraceElement.html "StackTraceElement")[]` \| `[getStackTrace](#getStackTrace())()` \| \| \| `public void` \| `[printStackTrace](#printStackTrace(java.io.PrintStream))([PrintStream](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html "PrintStream") s)` \| \| \| `public void` \| `[printStackTrace](#printStackTrace(java.io.PrintWriter))([PrintWriter](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html "PrintWriter") s)` \| \| \| `public void` \| `[printStackTrace](#printStackTrace())()` \| Constructor Detail ------------------ ### public JsonInternalException([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message) ### public JsonInternalException([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message, [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html "Throwable") cause) ### public JsonInternalException([Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html "Throwable") cause) Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html "Throwable") getCause() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getLocalizedMessage() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getMessage() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [StackTraceElement](https://docs.oracle.com/javase/8/docs/api/java/lang/StackTraceElement.html "StackTraceElement")[] getStackTrace() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void printStackTrace([PrintStream](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html "PrintStream") s) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void printStackTrace([PrintWriter](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html "PrintWriter") s) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void printStackTrace() groovy [Java] Class CharScanner [Java] Class CharScanner ======================== * org.apache.groovy.json.internal.CharScanner ``` public class CharScanner extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `protected static int` \| `[ALPHA\_0](#ALPHA_0)` \| \| \| `protected static int` \| `[ALPHA\_9](#ALPHA_9)` \| \| \| `protected static int` \| `[CLOSED\_BRACKET](#CLOSED_BRACKET)` \| \| \| `protected static int` \| `[CLOSED\_CURLY](#CLOSED_CURLY)` \| \| \| `protected static int` \| `[COMMA](#COMMA)` \| \| \| `protected static int` \| `[DECIMAL\_POINT](#DECIMAL_POINT)` \| \| \| `protected static int` \| `[LETTER\_BIG\_E](#LETTER_BIG_E)` \| \| \| `protected static int` \| `[LETTER\_E](#LETTER_E)` \| \| \| `protected static int` \| `[MINUS](#MINUS)` \| \| \| `protected static int` \| `[PLUS](#PLUS)` \| \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[debugCharDescription](#debugCharDescription(int))(int c)` \| \| \| `public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[errorDetails](#errorDetails(java.lang.String,%20char%5B%5D,%20int,%20int))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message, char[] array, int index, int ch)` \| \| \| `public static boolean` \| `[hasDecimalChar](#hasDecimalChar(char%5B%5D,%20boolean))(char[] chars, boolean negative)` \| \| \| `public static boolean` \| `[isDecimalChar](#isDecimalChar(int))(int currentChar)` \| \| \| `public static boolean` \| `[isDecimalDigit](#isDecimalDigit(int))(int c)` \| \| \| `protected static boolean` \| `[isDelimiter](#isDelimiter(int))(int c)` \| \| \| `public static boolean` \| `[isDigit](#isDigit(int))(int c)` \| \| \| `public static boolean` \| `[isInteger](#isInteger(char%5B%5D))(char[] digitChars)` \| \| \| `public static boolean` \| `[isInteger](#isInteger(char%5B%5D,%20int,%20int))(char[] digitChars, int offset, int len)` \| \| \| `public static boolean` \| `[isLong](#isLong(char%5B%5D))(char[] digitChars)` \| \| \| `public static boolean` \| `[isLong](#isLong(char%5B%5D,%20int,%20int))(char[] digitChars, int offset, int len)` \| \| \| `public static boolean` \| `[isNumberDigit](#isNumberDigit(int))(int c)` \| \| \| `public static [BigDecimal](https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html "BigDecimal")` \| `[parseBigDecimal](#parseBigDecimal(char%5B%5D))(char[] buffer)` \| \| \| `public static double` \| `[parseDouble](#parseDouble(char%5B%5D,%20int,%20int))(char[] buffer, int from, int to)` \| \| \| `public static float` \| `[parseFloat](#parseFloat(char%5B%5D,%20int,%20int))(char[] buffer, int from, int to)` \| \| \| `public static int` \| `[parseInt](#parseInt(char%5B%5D))(char[] digitChars)` \| \| \| `public static int` \| `[parseIntFromTo](#parseIntFromTo(char%5B%5D,%20int,%20int))(char[] digitChars, int offset, int to)` \| \| \| `public static int` \| `[parseIntFromToIgnoreDot](#parseIntFromToIgnoreDot(char%5B%5D,%20int,%20int))(char[] digitChars, int offset, int to)` \| \| \| `public static [Number](https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html "Number")` \| `[parseJsonNumber](#parseJsonNumber(char%5B%5D))(char[] buffer)` \| \| \| `public static [Number](https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html "Number")` \| `[parseJsonNumber](#parseJsonNumber(char%5B%5D,%20int,%20int))(char[] buffer, int from, int to)` \| \| \| `public static [Number](https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html "Number")` \| `[parseJsonNumber](#parseJsonNumber(char%5B%5D,%20int,%20int,%20int%5B%5D))(char[] buffer, int from, int max, int[] size)` \| \| \| `public static long` \| `[parseLong](#parseLong(char%5B%5D))(char[] digitChars)` \| \| \| `public static long` \| `[parseLongFromTo](#parseLongFromTo(char%5B%5D,%20int,%20int))(char[] digitChars, int offset, int to)` \| \| \| `public static long` \| `[parseLongFromToIgnoreDot](#parseLongFromToIgnoreDot(char%5B%5D,%20int,%20int))(char[] digitChars, int offset, int to)` \| \| \| `public static char[]` \| `[readNumber](#readNumber(char%5B%5D,%20int,%20int))(char[] array, int idx, int len)` \| \| \| `public static int` \| `[skipWhiteSpace](#skipWhiteSpace(char%5B%5D,%20int,%20int))(char[] array, int index, int length)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Field Detail ------------ ### protected static final int ALPHA\_0 ### protected static final int ALPHA\_9 ### protected static final int CLOSED\_BRACKET ### protected static final int CLOSED\_CURLY ### protected static final int COMMA ### protected static final int DECIMAL\_POINT ### protected static final int LETTER\_BIG\_E ### protected static final int LETTER\_E ### protected static final int MINUS ### protected static final int PLUS Method Detail ------------- ### public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") debugCharDescription(int c) ### public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") errorDetails([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message, char[] array, int index, int ch) ### public static boolean hasDecimalChar(char[] chars, boolean negative) ### public static boolean isDecimalChar(int currentChar) ### public static boolean isDecimalDigit(int c) ### protected static boolean isDelimiter(int c) ### public static boolean isDigit(int c) ### public static boolean isInteger(char[] digitChars) ### public static boolean isInteger(char[] digitChars, int offset, int len) ### public static boolean isLong(char[] digitChars) ### public static boolean isLong(char[] digitChars, int offset, int len) ### public static boolean isNumberDigit(int c) ### public static [BigDecimal](https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html "BigDecimal") parseBigDecimal(char[] buffer) ### public static double parseDouble(char[] buffer, int from, int to) ### public static float parseFloat(char[] buffer, int from, int to) ### public static int parseInt(char[] digitChars) ### public static int parseIntFromTo(char[] digitChars, int offset, int to) ### public static int parseIntFromToIgnoreDot(char[] digitChars, int offset, int to) ### public static [Number](https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html "Number") parseJsonNumber(char[] buffer) ### public static [Number](https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html "Number") parseJsonNumber(char[] buffer, int from, int to) ### public static [Number](https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html "Number") parseJsonNumber(char[] buffer, int from, int max, int[] size) ### public static long parseLong(char[] digitChars) ### public static long parseLongFromTo(char[] digitChars, int offset, int to) ### public static long parseLongFromToIgnoreDot(char[] digitChars, int offset, int to) ### public static char[] readNumber(char[] array, int idx, int len) ### public static int skipWhiteSpace(char[] array, int index, int length) groovy [Java] Class NumberValue [Java] Class NumberValue ======================== * org.apache.groovy.json.internal.NumberValue All Implemented Interfaces and Traits: [Value](value) ``` public class NumberValue extends [java.langNumber](../../../../../java.langnumber) implements [Value](value) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[NumberValue](#NumberValue(org.apache.groovy.json.internal.Type))([Type](type) type)` \| \| `[NumberValue](#NumberValue())()` \| \| `[NumberValue](#NumberValue(boolean,%20org.apache.groovy.json.internal.Type,%20int,%20int,%20char%5B%5D))(boolean chop, [Type](type) type, int startIndex, int endIndex, char[] buffer)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [BigDecimal](https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html "BigDecimal")` \| `[bigDecimalValue](#bigDecimalValue())()` \| \| \| `public [BigInteger](https://docs.oracle.com/javase/8/docs/api/java/math/BigInteger.html "BigInteger")` \| `[bigIntegerValue](#bigIntegerValue())()` \| \| \| `public boolean` \| `[booleanValue](#booleanValue())()` \| \| \| `public byte` \| `[byteValue](#byteValue())()` \| \| \| `public char` \| `[charValue](#charValue())()` \| \| \| `public final void` \| `[chop](#chop())()` \| \| \| `public [Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date")` \| `[dateValue](#dateValue())()` \| \| \| `public double` \| `[doubleValue](#doubleValue())()` \| \| \| `public boolean` \| `[equals](#equals(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o)` \| \| \| `public float` \| `[floatValue](#floatValue())()` \| \| \| `public int` \| `[hashCode](#hashCode())()` \| \| \| `public int` \| `[intValue](#intValue())()` \| \| \| `public boolean` \| `[isContainer](#isContainer())()` \| \| \| `public long` \| `[longValue](#longValue())()` \| \| \| `public short` \| `[shortValue](#shortValue())()` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[stringValue](#stringValue())()` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[stringValueEncoded](#stringValueEncoded())()` \| \| `<T extends Enum>` \| `public T` \| `[toEnum](#toEnum(Class))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<T> cls)` \| \| `<T extends Enum>` \| `public static T` \| `[toEnum](#toEnum(Class,%20int))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<T> cls, int value)` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[toString](#toString())()` \| \| \| `public final [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[toValue](#toValue())()` \| Constructor Detail ------------------ ### public NumberValue([Type](type) type) ### public NumberValue() ### public NumberValue(boolean chop, [Type](type) type, int startIndex, int endIndex, char[] buffer) Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [BigDecimal](https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html "BigDecimal") bigDecimalValue() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [BigInteger](https://docs.oracle.com/javase/8/docs/api/java/math/BigInteger.html "BigInteger") bigIntegerValue() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean booleanValue() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public byte byteValue() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public char charValue() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public final void chop() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") dateValue() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public double doubleValue() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean equals([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public float floatValue() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public int hashCode() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public int intValue() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean isContainer() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public long longValue() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public short shortValue() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") stringValue() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") stringValueEncoded() ### <T extends Enum> @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public T toEnum([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<T> cls) ### <T extends Enum> public static T toEnum([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<T> cls, int value) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") toString() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public final [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") toValue()	programming_docs
groovy [Java] Class JsonFastParser [Java] Class JsonFastParser =========================== * org.apache.groovy.json.internal.JsonFastParser ``` public class JsonFastParser extends [JsonParserCharArray](jsonparserchararray) ``` This works in index overlay mode or chop mode. Chop mode reduces possibility of memory leak but causes a few more buffer copies as it chops up the buffer. Inherited fields \| Fields inherited from class \| Fields \| \| `class [JsonParserCharArray](jsonparserchararray)` \| `[FALSE](jsonparserchararray#FALSE), [NULL](jsonparserchararray#NULL), [TRUE](jsonparserchararray#TRUE), [\_\_currentChar](jsonparserchararray#__currentChar), [\_\_index](jsonparserchararray#__index), [charArray](jsonparserchararray#charArray)` \| \| `class [BaseJsonParser](basejsonparser)` \| `[ALPHA\_0](basejsonparser#ALPHA_0), [ALPHA\_1](basejsonparser#ALPHA_1), [ALPHA\_2](basejsonparser#ALPHA_2), [ALPHA\_3](basejsonparser#ALPHA_3), [ALPHA\_4](basejsonparser#ALPHA_4), [ALPHA\_5](basejsonparser#ALPHA_5), [ALPHA\_6](basejsonparser#ALPHA_6), [ALPHA\_7](basejsonparser#ALPHA_7), [ALPHA\_8](basejsonparser#ALPHA_8), [ALPHA\_9](basejsonparser#ALPHA_9), [CLOSED\_BRACKET](basejsonparser#CLOSED_BRACKET), [CLOSED\_CURLY](basejsonparser#CLOSED_CURLY), [COLON](basejsonparser#COLON), [COMMA](basejsonparser#COMMA), [DECIMAL\_POINT](basejsonparser#DECIMAL_POINT), [DOUBLE\_QUOTE](basejsonparser#DOUBLE_QUOTE), [ESCAPE](basejsonparser#ESCAPE), [LETTER\_BIG\_E](basejsonparser#LETTER_BIG_E), [LETTER\_E](basejsonparser#LETTER_E), [MINUS](basejsonparser#MINUS), [PLUS](basejsonparser#PLUS), [bufSize](basejsonparser#bufSize), [charset](basejsonparser#charset), [internKeys](basejsonparser#internKeys), [internedKeysCache](basejsonparser#internedKeysCache)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[JsonFastParser](#JsonFastParser())()` \| \| `[JsonFastParser](#JsonFastParser(boolean))(boolean useValues)` \| \| `[JsonFastParser](#JsonFastParser(boolean,%20boolean))(boolean useValues, boolean chop)` \| \| `[JsonFastParser](#JsonFastParser(boolean,%20boolean,%20boolean))(boolean useValues, boolean chop, boolean lazyChop)` \| \| `[JsonFastParser](#JsonFastParser(boolean,%20boolean,%20boolean,%20boolean))(boolean useValues, boolean chop, boolean lazyChop, boolean checkDates)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `protected final [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[decodeFromChars](#decodeFromChars(char%5B%5D))(char[] cs)` \| \| \| `protected final [Value](value)` \| `[decodeJsonObjectLazyFinalParse](#decodeJsonObjectLazyFinalParse())()` \| \| \| `protected [Value](value)` \| `[decodeValue](#decodeValue())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [JsonParserCharArray](jsonparserchararray)` \| `[complain](jsonparserchararray#complain(java.lang.String)), [currentChar](jsonparserchararray#currentChar()), [decodeFalse](jsonparserchararray#decodeFalse()), [decodeFromChars](jsonparserchararray#decodeFromChars(char%5B%5D)), [decodeJsonArray](jsonparserchararray#decodeJsonArray()), [decodeJsonObject](jsonparserchararray#decodeJsonObject()), [decodeNull](jsonparserchararray#decodeNull()), [decodeTrue](jsonparserchararray#decodeTrue()), [decodeValue](jsonparserchararray#decodeValue()), [exceptionDetails](jsonparserchararray#exceptionDetails(java.lang.String)), [hasCurrent](jsonparserchararray#hasCurrent()), [hasMore](jsonparserchararray#hasMore()), [nextChar](jsonparserchararray#nextChar()), [parse](jsonparserchararray#parse(char%5B%5D)), [skipWhiteSpace](jsonparserchararray#skipWhiteSpace())` \| \| `class [BaseJsonParser](basejsonparser)` \| `[charDescription](basejsonparser#charDescription(int)), [findEndQuote](basejsonparser#findEndQuote(char%5B%5D,%20int)), [hasEscapeChar](basejsonparser#hasEscapeChar(char%5B%5D,%20int,%20int%5B%5D)), [isDecimalChar](basejsonparser#isDecimalChar(int)), [isDelimiter](basejsonparser#isDelimiter(int)), [isDoubleQuote](basejsonparser#isDoubleQuote(int)), [isEscape](basejsonparser#isEscape(int)), [isNumberDigit](basejsonparser#isNumberDigit(int)), [parse](basejsonparser#parse(java.lang.String)), [parse](basejsonparser#parse(byte%5B%5D)), [parse](basejsonparser#parse(byte%5B%5D,%20java.lang.String)), [parse](basejsonparser#parse(java.lang.CharSequence)), [parse](basejsonparser#parse(java.io.Reader)), [parse](basejsonparser#parse(java.io.InputStream)), [parse](basejsonparser#parse(java.io.InputStream,%20java.lang.String)), [parse](basejsonparser#parse(java.io.File,%20java.lang.String)), [setCharset](basejsonparser#setCharset(java.lang.String))` \| Constructor Detail ------------------ ### public JsonFastParser() ### public JsonFastParser(boolean useValues) ### public JsonFastParser(boolean useValues, boolean chop) ### public JsonFastParser(boolean useValues, boolean chop, boolean lazyChop) ### public JsonFastParser(boolean useValues, boolean chop, boolean lazyChop, boolean checkDates) Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected final [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") decodeFromChars(char[] cs) ### protected final [Value](value) decodeJsonObjectLazyFinalParse() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected [Value](value) decodeValue() groovy [Java] Class LazyValueMap [Java] Class LazyValueMap ========================= * org.apache.groovy.json.internal.LazyValueMap All Implemented Interfaces and Traits: [ValueMap](valuemap) ``` public class LazyValueMap extends [AbstractMap](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html "AbstractMap") implements [ValueMap](valuemap) ``` This class is important to the performance of the parser. It stores Value objects in a map where they are evaluated lazily. This is great for JSONPath types of application, and Object Serialization but not for maps that are going to be stored in a cache. This is because the Value construct is a type of index overlay that merely tracks where the token is located in the buffer, and what if any thing we noted about it (like can be converted to a decimal number, etc.). To mitigate memory leaks this class along with CharSequenceValue implement two constructs, namely, chop, and lazyChop. A chop is when we convert backing buffer of a Value object into a smaller buffer. A lazyChop is when we do a chop but only when a get operation is called. The lazyChop is performed on the tree that is touched by the JSONPath expression or its ilk. The chop operation can be done during parsing or lazily by storing the values in this construct. Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[LazyValueMap](#LazyValueMap(boolean))(boolean lazyChop)` \| \| `[LazyValueMap](#LazyValueMap(boolean,%20int))(boolean lazyChop, int initialSize)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public final void` \| `[add](#add(org.apache.groovy.json.internal.MapItemValue))([MapItemValue](mapitemvalue) miv)`Adds a new MapItemValue to the mapping. \| \| \| `public final void` \| `[chopMap](#chopMap())()`Chop this map. \| \| \| `public [Set](https://docs.oracle.com/javase/8/docs/api/java/util/Set.html "Set")<Entry<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")>>` \| `[entrySet](#entrySet())()` \| \| \| `public final [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[get](#get(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") key)`Gets the item by key from the mapping. \| \| \| `public boolean` \| `[hydrated](#hydrated())()` \| \| \| `public Entry<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Value](value "Value")>[]` \| `[items](#items())()` \| \| \| `public int` \| `[len](#len())()` \| \| \| `public [Value](value)` \| `[put](#put(java.lang.String,%20java.lang.Object))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") key, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| \| \| `public int` \| `[size](#size())()` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[toString](#toString())()` \| \| \| `public [Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection")<[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")>` \| `[values](#values())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractMap](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html "AbstractMap")` \| `[remove](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#remove(java.lang.Object) "remove"), [get](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#get(java.lang.Object) "get"), [put](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#put(java.lang.Object,%20java.lang.Object) "put"), [equals](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#toString() "toString"), [values](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#values() "values"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#hashCode() "hashCode"), [clear](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#clear() "clear"), [isEmpty](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#isEmpty() "isEmpty"), [size](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#size() "size"), [entrySet](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#entrySet() "entrySet"), [putAll](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#putAll(java.util.Map) "putAll"), [containsKey](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#containsKey(java.lang.Object) "containsKey"), [keySet](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#keySet() "keySet"), [containsValue](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#containsValue(java.lang.Object) "containsValue"), [wait](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#wait(long) "wait"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#notifyAll() "notifyAll"), [remove](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#remove(java.lang.Object,%20java.lang.Object) "remove"), [replace](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#replace(java.lang.Object,%20java.lang.Object) "replace"), [replace](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#replace(java.lang.Object,%20java.lang.Object,%20java.lang.Object) "replace"), [replaceAll](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#replaceAll(java.util.function.BiFunction) "replaceAll"), [merge](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#merge(java.lang.Object,%20java.lang.Object,%20java.util.function.BiFunction) "merge"), [putIfAbsent](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#putIfAbsent(java.lang.Object,%20java.lang.Object) "putIfAbsent"), [compute](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#compute(java.lang.Object,%20java.util.function.BiFunction) "compute"), [forEach](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#forEach(java.util.function.BiConsumer) "forEach"), [computeIfAbsent](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#computeIfAbsent(java.lang.Object,%20java.util.function.Function) "computeIfAbsent"), [getOrDefault](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#getOrDefault(java.lang.Object,%20java.lang.Object) "getOrDefault"), [computeIfPresent](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#computeIfPresent(java.lang.Object,%20java.util.function.BiFunction) "computeIfPresent")` \| Constructor Detail ------------------ ### @[SuppressWarnings](https://docs.oracle.com/javase/8/docs/api/java/lang/SuppressWarnings.html "SuppressWarnings")("unchecked") public LazyValueMap(boolean lazyChop) ### @[SuppressWarnings](https://docs.oracle.com/javase/8/docs/api/java/lang/SuppressWarnings.html "SuppressWarnings")("unchecked") public LazyValueMap(boolean lazyChop, int initialSize) Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public final void add([MapItemValue](mapitemvalue) miv) Adds a new MapItemValue to the mapping. Parameters: `miv` - miv we are adding. ### public final void chopMap() Chop this map. ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Set](https://docs.oracle.com/javase/8/docs/api/java/util/Set.html "Set")<Entry<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")>> entrySet() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public final [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") get([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") key) Gets the item by key from the mapping. Parameters: `key` - to lookup Returns: the item for the given key ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean hydrated() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public Entry<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Value](value "Value")>[] items() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public int len() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Value](value) put([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") key, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public int size() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") toString() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection")<[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")> values() groovy [Java] Interface Value [Java] Interface Value ====================== ``` public interface Value ``` Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [BigDecimal](https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html "BigDecimal")` \| `[bigDecimalValue](#bigDecimalValue())()` \| \| \| `public [BigInteger](https://docs.oracle.com/javase/8/docs/api/java/math/BigInteger.html "BigInteger")` \| `[bigIntegerValue](#bigIntegerValue())()` \| \| \| `public boolean` \| `[booleanValue](#booleanValue())()` \| \| \| `public byte` \| `[byteValue](#byteValue())()` \| \| \| `public char` \| `[charValue](#charValue())()` \| \| \| `public void` \| `[chop](#chop())()` \| \| \| `public [Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date")` \| `[dateValue](#dateValue())()` \| \| \| `public double` \| `[doubleValue](#doubleValue())()` \| \| \| `public float` \| `[floatValue](#floatValue())()` \| \| \| `public int` \| `[intValue](#intValue())()` \| \| \| `public boolean` \| `[isContainer](#isContainer())()` \| \| \| `public long` \| `[longValue](#longValue())()` \| \| \| `public short` \| `[shortValue](#shortValue())()` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[stringValue](#stringValue())()` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[stringValueEncoded](#stringValueEncoded())()` \| \| `<T extends Enum>` \| `public T` \| `[toEnum](#toEnum(Class))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<T> cls)` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[toValue](#toValue())()` \| Method Detail ------------- ### public [BigDecimal](https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html "BigDecimal") bigDecimalValue() ### public [BigInteger](https://docs.oracle.com/javase/8/docs/api/java/math/BigInteger.html "BigInteger") bigIntegerValue() ### public boolean booleanValue() ### public byte byteValue() ### public char charValue() ### public void chop() ### public [Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") dateValue() ### public double doubleValue() ### public float floatValue() ### public int intValue() ### public boolean isContainer() ### public long longValue() ### public short shortValue() ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") stringValue() ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") stringValueEncoded() ### <T extends Enum> public T toEnum([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<T> cls) ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") toValue() groovy [Java] Class LazyMap [Java] Class LazyMap ==================== * org.apache.groovy.json.internal.LazyMap ``` public class LazyMap extends [AbstractMap](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html "AbstractMap") ``` This maps only builds once you ask for a key for the first time. It is designed to not incur the overhead of creating a map unless needed. Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[LazyMap](#LazyMap())()` \| \| `[LazyMap](#LazyMap(int))(int initialSize)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public void` \| `[clear](#clear())()` \| \| \| `public [LazyMap](lazymap)` \| `[clearAndCopy](#clearAndCopy())()` \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[clone](#clone())()` \| \| \| `public boolean` \| `[containsKey](#containsKey(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") key)` \| \| \| `public boolean` \| `[containsValue](#containsValue(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| \| \| `public [Set](https://docs.oracle.com/javase/8/docs/api/java/util/Set.html "Set")<Entry<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")>>` \| `[entrySet](#entrySet())()` \| \| \| `public boolean` \| `[equals](#equals(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o)` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[get](#get(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") key)` \| \| `<V>` \| `public static V[]` \| `[grow](#grow(V))(V[] array)` \| \| \| `public int` \| `[hashCode](#hashCode())()` \| \| \| `public boolean` \| `[isEmpty](#isEmpty())()` \| \| \| `public [Set](https://docs.oracle.com/javase/8/docs/api/java/util/Set.html "Set")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>` \| `[keySet](#keySet())()` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[put](#put(java.lang.String,%20java.lang.Object))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") key, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| \| \| `public void` \| `[putAll](#putAll(java.util.Map))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") m)` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[remove](#remove(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") key)` \| \| \| `public int` \| `[size](#size())()` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[toString](#toString())()` \| \| \| `public [Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection")<[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")>` \| `[values](#values())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractMap](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html "AbstractMap")` \| `[remove](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#remove(java.lang.Object) "remove"), [get](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#get(java.lang.Object) "get"), [put](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#put(java.lang.Object,%20java.lang.Object) "put"), [equals](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#toString() "toString"), [values](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#values() "values"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#hashCode() "hashCode"), [clear](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#clear() "clear"), [isEmpty](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#isEmpty() "isEmpty"), [size](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#size() "size"), [entrySet](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#entrySet() "entrySet"), [putAll](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#putAll(java.util.Map) "putAll"), [containsKey](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#containsKey(java.lang.Object) "containsKey"), [keySet](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#keySet() "keySet"), [containsValue](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#containsValue(java.lang.Object) "containsValue"), [wait](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#wait(long) "wait"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#notifyAll() "notifyAll"), [remove](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#remove(java.lang.Object,%20java.lang.Object) "remove"), [replace](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#replace(java.lang.Object,%20java.lang.Object) "replace"), [replace](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#replace(java.lang.Object,%20java.lang.Object,%20java.lang.Object) "replace"), [replaceAll](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#replaceAll(java.util.function.BiFunction) "replaceAll"), [merge](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#merge(java.lang.Object,%20java.lang.Object,%20java.util.function.BiFunction) "merge"), [putIfAbsent](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#putIfAbsent(java.lang.Object,%20java.lang.Object) "putIfAbsent"), [compute](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#compute(java.lang.Object,%20java.util.function.BiFunction) "compute"), [forEach](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#forEach(java.util.function.BiConsumer) "forEach"), [computeIfAbsent](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#computeIfAbsent(java.lang.Object,%20java.util.function.Function) "computeIfAbsent"), [getOrDefault](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#getOrDefault(java.lang.Object,%20java.lang.Object) "getOrDefault"), [computeIfPresent](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#computeIfPresent(java.lang.Object,%20java.util.function.BiFunction) "computeIfPresent")` \| Constructor Detail ------------------ ### public LazyMap() ### public LazyMap(int initialSize) Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void clear() ### public [LazyMap](lazymap) clearAndCopy() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") clone() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean containsKey([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") key) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean containsValue([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Set](https://docs.oracle.com/javase/8/docs/api/java/util/Set.html "Set")<Entry<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")>> entrySet() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean equals([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") get([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") key) ### <V> public static V[] grow(V[] array) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public int hashCode() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean isEmpty() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Set](https://docs.oracle.com/javase/8/docs/api/java/util/Set.html "Set")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> keySet() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") put([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") key, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void putAll([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") m) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") remove([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") key) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public int size() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") toString() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection")<[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")> values()	programming_docs
groovy [Java] Class JsonStringDecoder [Java] Class JsonStringDecoder ============================== * org.apache.groovy.json.internal.JsonStringDecoder ``` public class JsonStringDecoder extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[decode](#decode(char%5B%5D,%20int,%20int))(char[] chars, int start, int to)` \| \| \| `public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[decodeForSure](#decodeForSure(char%5B%5D,%20int,%20int))(char[] chars, int start, int to)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") decode(char[] chars, int start, int to) ### public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") decodeForSure(char[] chars, int start, int to) groovy [Java] Class JsonParserLax [Java] Class JsonParserLax ========================== * org.apache.groovy.json.internal.JsonParserLax ``` public class JsonParserLax extends [JsonParserCharArray](jsonparserchararray) ``` Inherited fields \| Fields inherited from class \| Fields \| \| `class [JsonParserCharArray](jsonparserchararray)` \| `[FALSE](jsonparserchararray#FALSE), [NULL](jsonparserchararray#NULL), [TRUE](jsonparserchararray#TRUE), [\_\_currentChar](jsonparserchararray#__currentChar), [\_\_index](jsonparserchararray#__index), [charArray](jsonparserchararray#charArray)` \| \| `class [BaseJsonParser](basejsonparser)` \| `[ALPHA\_0](basejsonparser#ALPHA_0), [ALPHA\_1](basejsonparser#ALPHA_1), [ALPHA\_2](basejsonparser#ALPHA_2), [ALPHA\_3](basejsonparser#ALPHA_3), [ALPHA\_4](basejsonparser#ALPHA_4), [ALPHA\_5](basejsonparser#ALPHA_5), [ALPHA\_6](basejsonparser#ALPHA_6), [ALPHA\_7](basejsonparser#ALPHA_7), [ALPHA\_8](basejsonparser#ALPHA_8), [ALPHA\_9](basejsonparser#ALPHA_9), [CLOSED\_BRACKET](basejsonparser#CLOSED_BRACKET), [CLOSED\_CURLY](basejsonparser#CLOSED_CURLY), [COLON](basejsonparser#COLON), [COMMA](basejsonparser#COMMA), [DECIMAL\_POINT](basejsonparser#DECIMAL_POINT), [DOUBLE\_QUOTE](basejsonparser#DOUBLE_QUOTE), [ESCAPE](basejsonparser#ESCAPE), [LETTER\_BIG\_E](basejsonparser#LETTER_BIG_E), [LETTER\_E](basejsonparser#LETTER_E), [MINUS](basejsonparser#MINUS), [PLUS](basejsonparser#PLUS), [bufSize](basejsonparser#bufSize), [charset](basejsonparser#charset), [internKeys](basejsonparser#internKeys), [internedKeysCache](basejsonparser#internedKeysCache)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[JsonParserLax](#JsonParserLax())()` \| \| `[JsonParserLax](#JsonParserLax(boolean))(boolean useValues)` \| \| `[JsonParserLax](#JsonParserLax(boolean,%20boolean))(boolean useValues, boolean chop)` \| \| `[JsonParserLax](#JsonParserLax(boolean,%20boolean,%20boolean))(boolean useValues, boolean chop, boolean lazyChop)` \| \| `[JsonParserLax](#JsonParserLax(boolean,%20boolean,%20boolean,%20boolean))(boolean useValues, boolean chop, boolean lazyChop, boolean defaultCheckDates)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `protected final [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[decodeFromChars](#decodeFromChars(char%5B%5D))(char[] cs)` \| \| \| `protected final [Value](value)` \| `[decodeNumberLax](#decodeNumberLax(boolean))(boolean minus)`Decodes a number from a JSON value. \| \| \| `protected final [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[decodeValue](#decodeValue())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [JsonParserCharArray](jsonparserchararray)` \| `[complain](jsonparserchararray#complain(java.lang.String)), [currentChar](jsonparserchararray#currentChar()), [decodeFalse](jsonparserchararray#decodeFalse()), [decodeFromChars](jsonparserchararray#decodeFromChars(char%5B%5D)), [decodeJsonArray](jsonparserchararray#decodeJsonArray()), [decodeJsonObject](jsonparserchararray#decodeJsonObject()), [decodeNull](jsonparserchararray#decodeNull()), [decodeTrue](jsonparserchararray#decodeTrue()), [decodeValue](jsonparserchararray#decodeValue()), [exceptionDetails](jsonparserchararray#exceptionDetails(java.lang.String)), [hasCurrent](jsonparserchararray#hasCurrent()), [hasMore](jsonparserchararray#hasMore()), [nextChar](jsonparserchararray#nextChar()), [parse](jsonparserchararray#parse(char%5B%5D)), [skipWhiteSpace](jsonparserchararray#skipWhiteSpace())` \| \| `class [BaseJsonParser](basejsonparser)` \| `[charDescription](basejsonparser#charDescription(int)), [findEndQuote](basejsonparser#findEndQuote(char%5B%5D,%20int)), [hasEscapeChar](basejsonparser#hasEscapeChar(char%5B%5D,%20int,%20int%5B%5D)), [isDecimalChar](basejsonparser#isDecimalChar(int)), [isDelimiter](basejsonparser#isDelimiter(int)), [isDoubleQuote](basejsonparser#isDoubleQuote(int)), [isEscape](basejsonparser#isEscape(int)), [isNumberDigit](basejsonparser#isNumberDigit(int)), [parse](basejsonparser#parse(java.lang.String)), [parse](basejsonparser#parse(byte%5B%5D)), [parse](basejsonparser#parse(byte%5B%5D,%20java.lang.String)), [parse](basejsonparser#parse(java.lang.CharSequence)), [parse](basejsonparser#parse(java.io.Reader)), [parse](basejsonparser#parse(java.io.InputStream)), [parse](basejsonparser#parse(java.io.InputStream,%20java.lang.String)), [parse](basejsonparser#parse(java.io.File,%20java.lang.String)), [setCharset](basejsonparser#setCharset(java.lang.String))` \| Constructor Detail ------------------ ### public JsonParserLax() ### public JsonParserLax(boolean useValues) ### public JsonParserLax(boolean useValues, boolean chop) ### public JsonParserLax(boolean useValues, boolean chop, boolean lazyChop) ### public JsonParserLax(boolean useValues, boolean chop, boolean lazyChop, boolean defaultCheckDates) Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected final [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") decodeFromChars(char[] cs) ### protected final [Value](value) decodeNumberLax(boolean minus) Decodes a number from a JSON value. If at any point it is determined that the value is not a valid number the value is treated as a `String`. Parameters: `minus` - indicate whether the number is negative Returns: a number, or `String` if not a valid number ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected final [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") decodeValue() groovy [Java] Class ValueContainer [Java] Class ValueContainer =========================== * org.apache.groovy.json.internal.ValueContainer All Implemented Interfaces and Traits: [CharSequence](https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html "CharSequence"), [Value](value) ``` public class ValueContainer extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") implements [CharSequence](https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html "CharSequence"), [Value](value) ``` Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `static [Value](value)` \| `[FALSE](#FALSE)` \| \| \| `static [Value](value)` \| `[NULL](#NULL)` \| \| \| `static [Value](value)` \| `[TRUE](#TRUE)` \| \| \| `boolean` \| `[decodeStrings](#decodeStrings)` \| \| \| `[Type](type)` \| `[type](#type)` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[value](#value)` \| \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[ValueContainer](#ValueContainer(java.lang.Object,%20org.apache.groovy.json.internal.Type,%20boolean))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Type](type) type, boolean decodeStrings)` \| \| `[ValueContainer](#ValueContainer(org.apache.groovy.json.internal.Type))([Type](type) type)` \| \| `[ValueContainer](#ValueContainer(Map))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")> map)` \| \| `[ValueContainer](#ValueContainer(List))([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")> list)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [BigDecimal](https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html "BigDecimal")` \| `[bigDecimalValue](#bigDecimalValue())()` \| \| \| `public [BigInteger](https://docs.oracle.com/javase/8/docs/api/java/math/BigInteger.html "BigInteger")` \| `[bigIntegerValue](#bigIntegerValue())()` \| \| \| `public boolean` \| `[booleanValue](#booleanValue())()` \| \| \| `public byte` \| `[byteValue](#byteValue())()` \| \| \| `public char` \| `[charAt](#charAt(int))(int index)` \| \| \| `public char` \| `[charValue](#charValue())()` \| \| \| `public void` \| `[chop](#chop())()` \| \| \| `public [Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date")` \| `[dateValue](#dateValue())()` \| \| \| `public double` \| `[doubleValue](#doubleValue())()` \| \| \| `public float` \| `[floatValue](#floatValue())()` \| \| \| `public int` \| `[intValue](#intValue())()` \| \| \| `public boolean` \| `[isContainer](#isContainer())()` \| \| \| `public int` \| `[length](#length())()` \| \| \| `public long` \| `[longValue](#longValue())()` \| \| \| `public short` \| `[shortValue](#shortValue())()` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[stringValue](#stringValue())()` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[stringValueEncoded](#stringValueEncoded())()` \| \| \| `public [CharSequence](https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html "CharSequence")` \| `[subSequence](#subSequence(int,%20int))(int start, int end)` \| \| `<T extends Enum>` \| `public T` \| `[toEnum](#toEnum(Class))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<T> cls)` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[toString](#toString())()` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[toValue](#toValue())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Field Detail ------------ ### public static final [Value](value) FALSE ### public static final [Value](value) NULL ### public static final [Value](value) TRUE ### public boolean decodeStrings ### public [Type](type) type ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value Constructor Detail ------------------ ### public ValueContainer([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Type](type) type, boolean decodeStrings) ### public ValueContainer([Type](type) type) ### public ValueContainer([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")> map) ### public ValueContainer([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")> list) Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [BigDecimal](https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html "BigDecimal") bigDecimalValue() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [BigInteger](https://docs.oracle.com/javase/8/docs/api/java/math/BigInteger.html "BigInteger") bigIntegerValue() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean booleanValue() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public byte byteValue() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public char charAt(int index) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public char charValue() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void chop() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") dateValue() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public double doubleValue() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public float floatValue() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public int intValue() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean isContainer() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public int length() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public long longValue() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public short shortValue() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") stringValue() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") stringValueEncoded() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [CharSequence](https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html "CharSequence") subSequence(int start, int end) ### <T extends Enum> @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") @[SuppressWarnings](https://docs.oracle.com/javase/8/docs/api/java/lang/SuppressWarnings.html "SuppressWarnings")("unchecked") public T toEnum([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<T> cls) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") toString() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") toValue() groovy [Java] Class ValueList [Java] Class ValueList ====================== * org.apache.groovy.json.internal.ValueList ``` public class ValueList extends [AbstractList](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractList.html "AbstractList") ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[ValueList](#ValueList(boolean))(boolean lazyChop)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public boolean` \| `[add](#add(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") obj)` \| \| \| `public void` \| `[chopList](#chopList())()` \| \| \| `public void` \| `[clear](#clear())()` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[get](#get(int))(int index)` \| \| \| `public [Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html "Iterator")<[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")>` \| `[iterator](#iterator())()` \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")>` \| `[list](#list())()` \| \| \| `public int` \| `[size](#size())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractList](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractList.html "AbstractList")` \| `[add](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractList.html#add(int,%20java.lang.Object) "add"), [add](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractList.html#add(java.lang.Object) "add"), [remove](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractList.html#remove(int) "remove"), [get](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractList.html#get(int) "get"), [equals](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractList.html#equals(java.lang.Object) "equals"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractList.html#hashCode() "hashCode"), [indexOf](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractList.html#indexOf(java.lang.Object) "indexOf"), [clear](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractList.html#clear() "clear"), [lastIndexOf](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractList.html#lastIndexOf(java.lang.Object) "lastIndexOf"), [subList](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractList.html#subList(int,%20int) "subList"), [iterator](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractList.html#iterator() "iterator"), [addAll](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractList.html#addAll(int,%20java.util.Collection) "addAll"), [set](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractList.html#set(int,%20java.lang.Object) "set"), [listIterator](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractList.html#listIterator() "listIterator"), [listIterator](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractList.html#listIterator(int) "listIterator"), [remove](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractList.html#remove(java.lang.Object) "remove"), [toString](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractList.html#toString() "toString"), [isEmpty](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractList.html#isEmpty() "isEmpty"), [size](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractList.html#size() "size"), [toArray](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractList.html#toArray() "toArray"), [toArray](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractList.html#toArray(%5BLjava.lang.Object;) "toArray"), [contains](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractList.html#contains(java.lang.Object) "contains"), [addAll](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractList.html#addAll(java.util.Collection) "addAll"), [removeAll](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractList.html#removeAll(java.util.Collection) "removeAll"), [retainAll](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractList.html#retainAll(java.util.Collection) "retainAll"), [containsAll](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractList.html#containsAll(java.util.Collection) "containsAll"), [wait](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractList.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractList.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractList.html#wait(long) "wait"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractList.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractList.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractList.html#notifyAll() "notifyAll"), [toArray](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractList.html#toArray(java.util.function.IntFunction) "toArray"), [stream](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractList.html#stream() "stream"), [spliterator](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractList.html#spliterator() "spliterator"), [removeIf](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractList.html#removeIf(java.util.function.Predicate) "removeIf"), [parallelStream](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractList.html#parallelStream() "parallelStream"), [forEach](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractList.html#forEach(java.util.function.Consumer) "forEach"), [replaceAll](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractList.html#replaceAll(java.util.function.UnaryOperator) "replaceAll"), [sort](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractList.html#sort(java.util.Comparator) "sort")` \| Constructor Detail ------------------ ### public ValueList(boolean lazyChop) Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean add([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") obj) ### public void chopList() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void clear() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") get(int index) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html "Iterator")<[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")> iterator() ### public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")> list() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public int size()	programming_docs
groovy [Java] Class Dates [Java] Class Dates ================== * org.apache.groovy.json.internal.Dates ``` public class Dates extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `static int` \| `[JSON\_TIME\_LENGTH](#JSON_TIME_LENGTH)` \| \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public static [Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date")` \| `[fromISO8601](#fromISO8601(char%5B%5D,%20int,%20int))(char[] charArray, int from, int to)` \| \| \| `public static [Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date")` \| `[fromJsonDate](#fromJsonDate(char%5B%5D,%20int,%20int))(char[] charArray, int from, int to)` \| \| \| `public static boolean` \| `[isISO8601](#isISO8601(char%5B%5D,%20int,%20int))(char[] charArray, int start, int to)` \| \| \| `public static boolean` \| `[isISO8601QuickCheck](#isISO8601QuickCheck(char%5B%5D,%20int,%20int))(char[] charArray, int start, int to)` \| \| \| `public static boolean` \| `[isJsonDate](#isJsonDate(char%5B%5D,%20int,%20int))(char[] charArray, int start, int to)` \| \| \| `public static [Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date")` \| `[toDate](#toDate(java.util.TimeZone,%20int,%20int,%20int,%20int,%20int,%20int))([TimeZone](https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html "TimeZone") tz, int year, int month, int day, int hour, int minute, int second)` \| \| \| `public static [Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date")` \| `[toDate](#toDate(java.util.TimeZone,%20int,%20int,%20int,%20int,%20int,%20int,%20int))([TimeZone](https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html "TimeZone") tz, int year, int month, int day, int hour, int minute, int second, int miliseconds)` \| \| \| `public static long` \| `[utc](#utc(long))(long time)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Field Detail ------------ ### public static final int JSON\_TIME\_LENGTH Method Detail ------------- ### public static [Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") fromISO8601(char[] charArray, int from, int to) ### public static [Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") fromJsonDate(char[] charArray, int from, int to) ### public static boolean isISO8601(char[] charArray, int start, int to) ### public static boolean isISO8601QuickCheck(char[] charArray, int start, int to) ### public static boolean isJsonDate(char[] charArray, int start, int to) ### public static [Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") toDate([TimeZone](https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html "TimeZone") tz, int year, int month, int day, int hour, int minute, int second) ### public static [Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") toDate([TimeZone](https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html "TimeZone") tz, int year, int month, int day, int hour, int minute, int second, int miliseconds) ### public static long utc(long time) groovy [Java] Class BaseJsonParser [Java] Class BaseJsonParser =========================== * org.apache.groovy.json.internal.BaseJsonParser All Implemented Interfaces and Traits: [JsonParser](../../../../../groovy/json/jsonparser) ``` public abstract class BaseJsonParser extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") implements [JsonParser](../../../../../groovy/json/jsonparser) ``` Base JSON parser. Scaled down version of Boon JsonParser with features removed that are JDK 1.7 dependent or Groovy duplicated functionality. Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `protected static int` \| `[ALPHA\_0](#ALPHA_0)` \| \| \| `protected static int` \| `[ALPHA\_1](#ALPHA_1)` \| \| \| `protected static int` \| `[ALPHA\_2](#ALPHA_2)` \| \| \| `protected static int` \| `[ALPHA\_3](#ALPHA_3)` \| \| \| `protected static int` \| `[ALPHA\_4](#ALPHA_4)` \| \| \| `protected static int` \| `[ALPHA\_5](#ALPHA_5)` \| \| \| `protected static int` \| `[ALPHA\_6](#ALPHA_6)` \| \| \| `protected static int` \| `[ALPHA\_7](#ALPHA_7)` \| \| \| `protected static int` \| `[ALPHA\_8](#ALPHA_8)` \| \| \| `protected static int` \| `[ALPHA\_9](#ALPHA_9)` \| \| \| `protected static int` \| `[CLOSED\_BRACKET](#CLOSED_BRACKET)` \| \| \| `protected static int` \| `[CLOSED\_CURLY](#CLOSED_CURLY)` \| \| \| `protected static int` \| `[COLON](#COLON)` \| \| \| `protected static int` \| `[COMMA](#COMMA)` \| \| \| `protected static int` \| `[DECIMAL\_POINT](#DECIMAL_POINT)` \| \| \| `protected static int` \| `[DOUBLE\_QUOTE](#DOUBLE_QUOTE)` \| \| \| `protected static int` \| `[ESCAPE](#ESCAPE)` \| \| \| `protected static int` \| `[LETTER\_BIG\_E](#LETTER_BIG_E)` \| \| \| `protected static int` \| `[LETTER\_E](#LETTER_E)` \| \| \| `protected static int` \| `[MINUS](#MINUS)` \| \| \| `protected static int` \| `[PLUS](#PLUS)` \| \| \| `protected int` \| `[bufSize](#bufSize)` \| \| \| `protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[charset](#charset)` \| \| \| `protected static boolean` \| `[internKeys](#internKeys)` \| \| \| `protected static [ConcurrentHashMap](https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ConcurrentHashMap.html "ConcurrentHashMap")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>` \| `[internedKeysCache](#internedKeysCache)` \| \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[charDescription](#charDescription(int))(int c)` \| \| \| `protected static int` \| `[findEndQuote](#findEndQuote(char%5B%5D,%20int))(char[] array, int index)` \| \| \| `protected static boolean` \| `[hasEscapeChar](#hasEscapeChar(char%5B%5D,%20int,%20int%5B%5D))(char[] array, int index, int[] indexHolder)` \| \| \| `protected static boolean` \| `[isDecimalChar](#isDecimalChar(int))(int currentChar)` \| \| \| `protected static boolean` \| `[isDelimiter](#isDelimiter(int))(int c)` \| \| \| `protected static final boolean` \| `[isDoubleQuote](#isDoubleQuote(int))(int c)` \| \| \| `protected static final boolean` \| `[isEscape](#isEscape(int))(int c)` \| \| \| `protected static final boolean` \| `[isNumberDigit](#isNumberDigit(int))(int c)` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[parse](#parse(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") jsonString)` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[parse](#parse(byte%5B%5D))(byte[] bytes)` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[parse](#parse(byte%5B%5D,%20java.lang.String))(byte[] bytes, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset)` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[parse](#parse(java.lang.CharSequence))([CharSequence](https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html "CharSequence") charSequence)` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[parse](#parse(java.io.Reader))([Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") reader)` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[parse](#parse(java.io.InputStream))([InputStream](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html "InputStream") input)` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[parse](#parse(java.io.InputStream,%20java.lang.String))([InputStream](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html "InputStream") input, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset)` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[parse](#parse(java.io.File,%20java.lang.String))([File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File") file, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset)` \| \| \| `public void` \| `[setCharset](#setCharset(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Field Detail ------------ ### protected static final int ALPHA\_0 ### protected static final int ALPHA\_1 ### protected static final int ALPHA\_2 ### protected static final int ALPHA\_3 ### protected static final int ALPHA\_4 ### protected static final int ALPHA\_5 ### protected static final int ALPHA\_6 ### protected static final int ALPHA\_7 ### protected static final int ALPHA\_8 ### protected static final int ALPHA\_9 ### protected static final int CLOSED\_BRACKET ### protected static final int CLOSED\_CURLY ### protected static final int COLON ### protected static final int COMMA ### protected static final int DECIMAL\_POINT ### protected static final int DOUBLE\_QUOTE ### protected static final int ESCAPE ### protected static final int LETTER\_BIG\_E ### protected static final int LETTER\_E ### protected static final int MINUS ### protected static final int PLUS ### protected int bufSize ### protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset ### protected static final boolean internKeys ### protected static final [ConcurrentHashMap](https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ConcurrentHashMap.html "ConcurrentHashMap")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> internedKeysCache Method Detail ------------- ### protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charDescription(int c) ### protected static int findEndQuote(char[] array, int index) ### protected static boolean hasEscapeChar(char[] array, int index, int[] indexHolder) ### protected static boolean isDecimalChar(int currentChar) ### protected static boolean isDelimiter(int c) ### protected static final boolean isDoubleQuote(int c) ### protected static final boolean isEscape(int c) ### protected static final boolean isNumberDigit(int c) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parse([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") jsonString) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parse(byte[] bytes) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parse(byte[] bytes, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parse([CharSequence](https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html "CharSequence") charSequence) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parse([Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") reader) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parse([InputStream](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html "InputStream") input) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parse([InputStream](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html "InputStream") input, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parse([File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File") file, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset) ### public void setCharset([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset) groovy [Java] Interface ValueMap<K, V> [Java] Interface ValueMap<K, V> =============================== ``` public interface ValueMap<K, V> extends [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") ``` Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public void` \| `[add](#add(org.apache.groovy.json.internal.MapItemValue))([MapItemValue](mapitemvalue) miv)` \| \| \| `public boolean` \| `[hydrated](#hydrated())()`Has the map been hydrated. \| \| \| `public Entry<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Value](value "Value")>[]` \| `[items](#items())()`Give me the items in the map without hydrating the map. \| \| \| `public int` \| `[len](#len())()`Return size w/o hydrating the map. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `interface [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")` \| `[remove](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html#remove(java.lang.Object) "remove"), [remove](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html#remove(java.lang.Object,%20java.lang.Object) "remove"), [get](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html#get(java.lang.Object) "get"), [put](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html#put(java.lang.Object,%20java.lang.Object) "put"), [equals](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html#equals(java.lang.Object) "equals"), [values](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html#values() "values"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html#hashCode() "hashCode"), [copyOf](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html#copyOf(java.util.Map) "copyOf"), [clear](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html#clear() "clear"), [isEmpty](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html#isEmpty() "isEmpty"), [replace](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html#replace(java.lang.Object,%20java.lang.Object) "replace"), [replace](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html#replace(java.lang.Object,%20java.lang.Object,%20java.lang.Object) "replace"), [replaceAll](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html#replaceAll(java.util.function.BiFunction) "replaceAll"), [size](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html#size() "size"), [of](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html#of(java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object) "of"), [of](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html#of(java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object) "of"), [of](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html#of(java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object) "of"), [of](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html#of() "of"), [of](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html#of(java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object) "of"), [of](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html#of(java.lang.Object,%20java.lang.Object) "of"), [of](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html#of(java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object) "of"), [of](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html#of(java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object) "of"), [of](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html#of(java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object) "of"), [of](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html#of(java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object) "of"), [of](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html#of(java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object) "of"), [merge](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html#merge(java.lang.Object,%20java.lang.Object,%20java.util.function.BiFunction) "merge"), [entrySet](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html#entrySet() "entrySet"), [putAll](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html#putAll(java.util.Map) "putAll"), [putIfAbsent](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html#putIfAbsent(java.lang.Object,%20java.lang.Object) "putIfAbsent"), [compute](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html#compute(java.lang.Object,%20java.util.function.BiFunction) "compute"), [entry](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html#entry(java.lang.Object,%20java.lang.Object) "entry"), [forEach](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html#forEach(java.util.function.BiConsumer) "forEach"), [containsKey](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html#containsKey(java.lang.Object) "containsKey"), [computeIfAbsent](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html#computeIfAbsent(java.lang.Object,%20java.util.function.Function) "computeIfAbsent"), [keySet](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html#keySet() "keySet"), [containsValue](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html#containsValue(java.lang.Object) "containsValue"), [getOrDefault](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html#getOrDefault(java.lang.Object,%20java.lang.Object) "getOrDefault"), [computeIfPresent](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html#computeIfPresent(java.lang.Object,%20java.util.function.BiFunction) "computeIfPresent"), [ofEntries](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html#ofEntries(%5BLjava.util.Map%24Entry;) "ofEntries")` \| Method Detail ------------- ### public void add([MapItemValue](mapitemvalue) miv) ### public boolean hydrated() Has the map been hydrated. ### public Entry<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Value](value "Value")>[] items() Give me the items in the map without hydrating the map. Realize that the array is likely larger than the length so array items can be null. ### public int len() Return size w/o hydrating the map.	programming_docs
groovy [Java] Class ExpressionUtils [Java] Class ExpressionUtils ============================ * org.apache.groovy.ast.tools.ExpressionUtils ``` public final class ExpressionUtils extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public static boolean` \| `[isNullConstant](#isNullConstant(org.codehaus.groovy.ast.expr.Expression))([Expression](../../../../codehaus/groovy/ast/expr/expression) expression)` \| \| \| `public static boolean` \| `[isNumberOrArrayOfNumber](#isNumberOrArrayOfNumber(org.codehaus.groovy.ast.ClassNode,%20boolean))([ClassNode](../../../../codehaus/groovy/ast/classnode) targetType, boolean recurse)`Determine if a type is derived from Number (or array thereof). \| \| \| `public static boolean` \| `[isSuperExpression](#isSuperExpression(org.codehaus.groovy.ast.expr.Expression))([Expression](../../../../codehaus/groovy/ast/expr/expression) expression)` \| \| \| `public static boolean` \| `[isThisExpression](#isThisExpression(org.codehaus.groovy.ast.expr.Expression))([Expression](../../../../codehaus/groovy/ast/expr/expression) expression)` \| \| \| `public static boolean` \| `[isThisOrSuper](#isThisOrSuper(org.codehaus.groovy.ast.expr.Expression))([Expression](../../../../codehaus/groovy/ast/expr/expression) expression)` \| \| \| `public static boolean` \| `[isTypeOrArrayOfType](#isTypeOrArrayOfType(org.codehaus.groovy.ast.ClassNode,%20org.codehaus.groovy.ast.ClassNode,%20boolean))([ClassNode](../../../../codehaus/groovy/ast/classnode) targetType, [ClassNode](../../../../codehaus/groovy/ast/classnode) type, boolean recurse)`Determine if a type matches another type (or array thereof). \| \| \| `public static [ConstantExpression](../../../../codehaus/groovy/ast/expr/constantexpression)` \| `[transformBinaryConstantExpression](#transformBinaryConstantExpression(org.codehaus.groovy.ast.expr.BinaryExpression,%20org.codehaus.groovy.ast.ClassNode))([BinaryExpression](../../../../codehaus/groovy/ast/expr/binaryexpression) be, [ClassNode](../../../../codehaus/groovy/ast/classnode) targetType)`Turns expressions of the form ConstantExpression(40) + ConstantExpression(2) into the simplified ConstantExpression(42) at compile time. \| \| \| `public static [Expression](../../../../codehaus/groovy/ast/expr/expression)` \| `[transformInlineConstants](#transformInlineConstants(org.codehaus.groovy.ast.expr.Expression,%20org.codehaus.groovy.ast.ClassNode))([Expression](../../../../codehaus/groovy/ast/expr/expression) exp, [ClassNode](../../../../codehaus/groovy/ast/classnode) attrType)`Converts simple expressions of constants into pre-evaluated simple constants. \| \| \| `public static [Expression](../../../../codehaus/groovy/ast/expr/expression)` \| `[transformInlineConstants](#transformInlineConstants(org.codehaus.groovy.ast.expr.Expression))([Expression](../../../../codehaus/groovy/ast/expr/expression) exp)`The attribute values of annotations must be primitive, String or Enum constants. \| \| \| `public static [Expression](../../../../codehaus/groovy/ast/expr/expression)` \| `[transformListOfConstants](#transformListOfConstants(org.codehaus.groovy.ast.expr.ListExpression,%20org.codehaus.groovy.ast.ClassNode))([ListExpression](../../../../codehaus/groovy/ast/expr/listexpression) origList, [ClassNode](../../../../codehaus/groovy/ast/classnode) attrType)`Given a list of constants, transform each item in the list. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### public static boolean isNullConstant([Expression](../../../../codehaus/groovy/ast/expr/expression) expression) ### public static boolean isNumberOrArrayOfNumber([ClassNode](../../../../codehaus/groovy/ast/classnode) targetType, boolean recurse) Determine if a type is derived from Number (or array thereof). Parameters: `targetType` - the candidate type `recurse` - true if we can have multi-dimension arrays; should be false for annotation member types Returns: true if the type equals the targetType or array thereof ### public static boolean isSuperExpression([Expression](../../../../codehaus/groovy/ast/expr/expression) expression) ### public static boolean isThisExpression([Expression](../../../../codehaus/groovy/ast/expr/expression) expression) ### public static boolean isThisOrSuper([Expression](../../../../codehaus/groovy/ast/expr/expression) expression) ### public static boolean isTypeOrArrayOfType([ClassNode](../../../../codehaus/groovy/ast/classnode) targetType, [ClassNode](../../../../codehaus/groovy/ast/classnode) type, boolean recurse) Determine if a type matches another type (or array thereof). Parameters: `targetType` - the candidate type `type` - the type we are checking against `recurse` - true if we can have multi-dimension arrays; should be false for annotation member types Returns: true if the type equals the targetType or array thereof ### public static [ConstantExpression](../../../../codehaus/groovy/ast/expr/constantexpression) transformBinaryConstantExpression([BinaryExpression](../../../../codehaus/groovy/ast/expr/binaryexpression) be, [ClassNode](../../../../codehaus/groovy/ast/classnode) targetType) Turns expressions of the form ConstantExpression(40) + ConstantExpression(2) into the simplified ConstantExpression(42) at compile time. Parameters: `be` - the binary expression `targetType` - the type of the result Returns: the transformed expression or the original if no transformation was performed ### public static [Expression](../../../../codehaus/groovy/ast/expr/expression) transformInlineConstants([Expression](../../../../codehaus/groovy/ast/expr/expression) exp, [ClassNode](../../../../codehaus/groovy/ast/classnode) attrType) Converts simple expressions of constants into pre-evaluated simple constants. Handles: * Property expressions - referencing constants * Simple binary expressions - String concatenation and numeric +, -, /, \* * List expressions - list of constants * Variable expressions - referencing constants Parameters: `exp` - the original expression `attrType` - the type that the final constant should be Returns: the transformed type or the original if no transformation was possible ### public static [Expression](../../../../codehaus/groovy/ast/expr/expression) transformInlineConstants([Expression](../../../../codehaus/groovy/ast/expr/expression) exp) The attribute values of annotations must be primitive, String or Enum constants. In various places, such constants can be seen during type resolution but won't be readily accessible in later phases, e.g. they might be embedded into constructor code. This method transforms constants that would appear in annotations early so they aren't lost. Subsequent processing determines whether they are valid, this method simply retains the constant value as a constant expression. Parameters: `exp` - the original expression Returns: the converted expression ### public static [Expression](../../../../codehaus/groovy/ast/expr/expression) transformListOfConstants([ListExpression](../../../../codehaus/groovy/ast/expr/listexpression) origList, [ClassNode](../../../../codehaus/groovy/ast/classnode) attrType) Given a list of constants, transform each item in the list. Parameters: `origList` - the list to transform `attrType` - the target type Returns: the transformed list or the original if nothing was changed groovy [Java] Class MethodNodeUtils [Java] Class MethodNodeUtils ============================ * org.apache.groovy.ast.tools.MethodNodeUtils ``` public class MethodNodeUtils extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Utility class for working with MethodNodes Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public static [BlockStatement](../../../../codehaus/groovy/ast/stmt/blockstatement)` \| `[getCodeAsBlock](#getCodeAsBlock(org.codehaus.groovy.ast.MethodNode))([MethodNode](../../../../codehaus/groovy/ast/methodnode) node)`Gets the code for a method (or constructor) as a block. \| \| \| `public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getPropertyName](#getPropertyName(org.codehaus.groovy.ast.MethodNode))([MethodNode](../../../../codehaus/groovy/ast/methodnode) mNode)`For a method node potentially representing a property, returns the name of the property. \| \| \| `public static boolean` \| `[isGetterCandidate](#isGetterCandidate(org.codehaus.groovy.ast.MethodNode))([MethodNode](../../../../codehaus/groovy/ast/methodnode) m)`Check if the [MethodNode](../../../../codehaus/groovy/ast/methodnode "MethodNode") instance is getter candidate \| \| \| `public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[methodDescriptor](#methodDescriptor(org.codehaus.groovy.ast.MethodNode))([MethodNode](../../../../codehaus/groovy/ast/methodnode) mNode)`Return the method node's descriptor which includes its return type, name and parameter types without generics. \| \| \| `public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[methodDescriptor](#methodDescriptor(org.codehaus.groovy.ast.MethodNode,%20boolean))([MethodNode](../../../../codehaus/groovy/ast/methodnode) mNode, boolean pretty)`Return the method node's descriptor which includes its return type, name and parameter types without generics. \| \| \| `public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[methodDescriptorWithoutReturnType](#methodDescriptorWithoutReturnType(org.codehaus.groovy.ast.MethodNode))([MethodNode](../../../../codehaus/groovy/ast/methodnode) mNode)`Return the method node's descriptor including its name and parameter types without generics. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### public static [BlockStatement](../../../../codehaus/groovy/ast/stmt/blockstatement) getCodeAsBlock([MethodNode](../../../../codehaus/groovy/ast/methodnode) node) Gets the code for a method (or constructor) as a block. If no code is found, an empty block will be returned. If a single non-block statement is found, a block containing that statement will be returned. Otherwise the existing block statement will be returned. The original `node` is not modified. Parameters: `node` - the method (or constructor) node Returns: the found or created block statement ### public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getPropertyName([MethodNode](../../../../codehaus/groovy/ast/methodnode) mNode) For a method node potentially representing a property, returns the name of the property. Parameters: `mNode` - a MethodNode Returns: the property name without the get/set/is prefix if a property or null ### public static boolean isGetterCandidate([MethodNode](../../../../codehaus/groovy/ast/methodnode) m) Check if the [MethodNode](../../../../codehaus/groovy/ast/methodnode "MethodNode") instance is getter candidate Parameters: `m` - the [MethodNode](../../../../codehaus/groovy/ast/methodnode "MethodNode") instance Returns: `true` if the instance is getter candidate Since: 4.0.0 ### public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodDescriptor([MethodNode](../../../../codehaus/groovy/ast/methodnode) mNode) Return the method node's descriptor which includes its return type, name and parameter types without generics. Parameters: `mNode` - the method node Returns: the method node's descriptor ### public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodDescriptor([MethodNode](../../../../codehaus/groovy/ast/methodnode) mNode, boolean pretty) Return the method node's descriptor which includes its return type, name and parameter types without generics. Parameters: `mNode` - the method node `pretty` - whether to quote a name with spaces Returns: the method node's descriptor ### public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodDescriptorWithoutReturnType([MethodNode](../../../../codehaus/groovy/ast/methodnode) mNode) Return the method node's descriptor including its name and parameter types without generics. Parameters: `mNode` - the method node Returns: the method node's abbreviated descriptor excluding the return type groovy [Java] Class MethodCallUtils [Java] Class MethodCallUtils ============================ * org.apache.groovy.ast.tools.MethodCallUtils ``` public class MethodCallUtils extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Utility class for commonly called methods Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public static [Statement](../../../../codehaus/groovy/ast/stmt/statement)` \| `[appendS](#appendS(org.codehaus.groovy.ast.expr.Expression,%20org.codehaus.groovy.ast.expr.Expression))([Expression](../../../../codehaus/groovy/ast/expr/expression) result, [Expression](../../../../codehaus/groovy/ast/expr/expression) expr)` \| \| \| `public static [Expression](../../../../codehaus/groovy/ast/expr/expression)` \| `[toStringX](#toStringX(org.codehaus.groovy.ast.expr.Expression))([Expression](../../../../codehaus/groovy/ast/expr/expression) object)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### public static [Statement](../../../../codehaus/groovy/ast/stmt/statement) appendS([Expression](../../../../codehaus/groovy/ast/expr/expression) result, [Expression](../../../../codehaus/groovy/ast/expr/expression) expr) ### public static [Expression](../../../../codehaus/groovy/ast/expr/expression) toStringX([Expression](../../../../codehaus/groovy/ast/expr/expression) object) groovy [Java] Class ConstructorNodeUtils [Java] Class ConstructorNodeUtils ================================= * org.apache.groovy.ast.tools.ConstructorNodeUtils ``` public class ConstructorNodeUtils extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Utility class for working with ConstructorNodes Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public static [Statement](../../../../codehaus/groovy/ast/stmt/statement)` \| `[checkPropNamesS](#checkPropNamesS(org.codehaus.groovy.ast.expr.VariableExpression,%20boolean,%20List))([VariableExpression](../../../../codehaus/groovy/ast/expr/variableexpression) namedArgs, boolean pojo, [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[PropertyNode](../../../../codehaus/groovy/ast/propertynode "PropertyNode")> props)` \| \| \| `public static [ConstructorCallExpression](../../../../codehaus/groovy/ast/expr/constructorcallexpression)` \| `[getFirstIfSpecialConstructorCall](#getFirstIfSpecialConstructorCall(org.codehaus.groovy.ast.stmt.Statement))([Statement](../../../../codehaus/groovy/ast/stmt/statement) code)`Return the first statement from the constructor code if it is a call to super or this, otherwise null. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### public static [Statement](../../../../codehaus/groovy/ast/stmt/statement) checkPropNamesS([VariableExpression](../../../../codehaus/groovy/ast/expr/variableexpression) namedArgs, boolean pojo, [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[PropertyNode](../../../../codehaus/groovy/ast/propertynode "PropertyNode")> props) ### public static [ConstructorCallExpression](../../../../codehaus/groovy/ast/expr/constructorcallexpression) getFirstIfSpecialConstructorCall([Statement](../../../../codehaus/groovy/ast/stmt/statement) code) Return the first statement from the constructor code if it is a call to super or this, otherwise null. Parameters: `code` - the code to check Returns: the first statement if a special call or null	programming_docs
groovy [Java] Class ImmutablePropertyUtils [Java] Class ImmutablePropertyUtils =================================== * org.apache.groovy.ast.tools.ImmutablePropertyUtils ``` public class ImmutablePropertyUtils extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `static [ClassNode](../../../../codehaus/groovy/ast/classnode)` \| `[IMMUTABLE\_OPTIONS\_TYPE](#IMMUTABLE_OPTIONS_TYPE)` \| \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public static boolean` \| `[builtinOrMarkedImmutableClass](#builtinOrMarkedImmutableClass(Class))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<?> clazz)` \| \| \| `public static [Expression](../../../../codehaus/groovy/ast/expr/expression)` \| `[cloneArrayOrCloneableExpr](#cloneArrayOrCloneableExpr(org.codehaus.groovy.ast.expr.Expression,%20org.codehaus.groovy.ast.ClassNode))([Expression](../../../../codehaus/groovy/ast/expr/expression) fieldExpr, [ClassNode](../../../../codehaus/groovy/ast/classnode) type)` \| \| \| `public static [Expression](../../../../codehaus/groovy/ast/expr/expression)` \| `[cloneDateExpr](#cloneDateExpr(org.codehaus.groovy.ast.expr.Expression))([Expression](../../../../codehaus/groovy/ast/expr/expression) origDate)` \| \| \| `public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[createErrorMessage](#createErrorMessage(java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") className, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") fieldName, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") typeName, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") mode)` \| \| \| `public static boolean` \| `[derivesFromDate](#derivesFromDate(org.codehaus.groovy.ast.ClassNode))([ClassNode](../../../../codehaus/groovy/ast/classnode) fieldType)` \| \| \| `public static [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>` \| `[getKnownImmutableClasses](#getKnownImmutableClasses(org.codehaus.groovy.transform.AbstractASTTransformation,%20org.codehaus.groovy.ast.ClassNode))([AbstractASTTransformation](../../../../codehaus/groovy/transform/abstractasttransformation) xform, [ClassNode](../../../../codehaus/groovy/ast/classnode) cNode)` \| \| \| `public static [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>` \| `[getKnownImmutables](#getKnownImmutables(org.codehaus.groovy.transform.AbstractASTTransformation,%20org.codehaus.groovy.ast.ClassNode))([AbstractASTTransformation](../../../../codehaus/groovy/transform/abstractasttransformation) xform, [ClassNode](../../../../codehaus/groovy/ast/classnode) cNode)` \| \| \| `public static boolean` \| `[implementsCloneable](#implementsCloneable(org.codehaus.groovy.ast.ClassNode))([ClassNode](../../../../codehaus/groovy/ast/classnode) fieldType)` \| \| \| `public static boolean` \| `[isBuiltinImmutable](#isBuiltinImmutable(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") typeName)` \| \| \| `public static boolean` \| `[isKnownImmutableType](#isKnownImmutableType(org.codehaus.groovy.ast.ClassNode,%20List))([ClassNode](../../../../codehaus/groovy/ast/classnode) fieldType, [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> knownImmutableClasses)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Field Detail ------------ ### public static final [ClassNode](../../../../codehaus/groovy/ast/classnode) IMMUTABLE\_OPTIONS\_TYPE Method Detail ------------- ### public static boolean builtinOrMarkedImmutableClass([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<?> clazz) ### public static [Expression](../../../../codehaus/groovy/ast/expr/expression) cloneArrayOrCloneableExpr([Expression](../../../../codehaus/groovy/ast/expr/expression) fieldExpr, [ClassNode](../../../../codehaus/groovy/ast/classnode) type) ### public static [Expression](../../../../codehaus/groovy/ast/expr/expression) cloneDateExpr([Expression](../../../../codehaus/groovy/ast/expr/expression) origDate) ### public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") createErrorMessage([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") className, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") fieldName, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") typeName, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") mode) ### public static boolean derivesFromDate([ClassNode](../../../../codehaus/groovy/ast/classnode) fieldType) ### public static [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> getKnownImmutableClasses([AbstractASTTransformation](../../../../codehaus/groovy/transform/abstractasttransformation) xform, [ClassNode](../../../../codehaus/groovy/ast/classnode) cNode) ### public static [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> getKnownImmutables([AbstractASTTransformation](../../../../codehaus/groovy/transform/abstractasttransformation) xform, [ClassNode](../../../../codehaus/groovy/ast/classnode) cNode) ### public static boolean implementsCloneable([ClassNode](../../../../codehaus/groovy/ast/classnode) fieldType) ### public static boolean isBuiltinImmutable([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") typeName) ### public static boolean isKnownImmutableType([ClassNode](../../../../codehaus/groovy/ast/classnode) fieldType, [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> knownImmutableClasses) groovy [Java] Class AnnotatedNodeUtils [Java] Class AnnotatedNodeUtils =============================== * org.apache.groovy.ast.tools.AnnotatedNodeUtils ``` public class AnnotatedNodeUtils extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Utility class for working with AnnotatedNodes Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public static boolean` \| `[hasAnnotation](#hasAnnotation(org.codehaus.groovy.ast.AnnotatedNode,%20org.codehaus.groovy.ast.ClassNode))([AnnotatedNode](../../../../codehaus/groovy/ast/annotatednode) node, [ClassNode](../../../../codehaus/groovy/ast/classnode) annotation)` \| \| \| `public static boolean` \| `[isGenerated](#isGenerated(org.codehaus.groovy.ast.AnnotatedNode))([AnnotatedNode](../../../../codehaus/groovy/ast/annotatednode) node)` \| \| `<T extends AnnotatedNode>` \| `public static T` \| `[markAsGenerated](#markAsGenerated(org.codehaus.groovy.ast.ClassNode,%20T))([ClassNode](../../../../codehaus/groovy/ast/classnode) containingClass, T nodeToMark)` \| \| `<T extends AnnotatedNode>` \| `public static T` \| `[markAsGenerated](#markAsGenerated(org.codehaus.groovy.ast.ClassNode,%20T,%20boolean))([ClassNode](../../../../codehaus/groovy/ast/classnode) containingClass, T nodeToMark, boolean skipChecks)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### public static boolean hasAnnotation([AnnotatedNode](../../../../codehaus/groovy/ast/annotatednode) node, [ClassNode](../../../../codehaus/groovy/ast/classnode) annotation) ### public static boolean isGenerated([AnnotatedNode](../../../../codehaus/groovy/ast/annotatednode) node) ### <T extends AnnotatedNode> public static T markAsGenerated([ClassNode](../../../../codehaus/groovy/ast/classnode) containingClass, T nodeToMark) ### <T extends AnnotatedNode> public static T markAsGenerated([ClassNode](../../../../codehaus/groovy/ast/classnode) containingClass, T nodeToMark, boolean skipChecks) groovy [Java] Class VisibilityUtils [Java] Class VisibilityUtils ============================ * org.apache.groovy.ast.tools.VisibilityUtils ``` public class VisibilityUtils extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public static int` \| `[getVisibility](#getVisibility(org.codehaus.groovy.ast.AnnotationNode,%20org.codehaus.groovy.ast.AnnotatedNode,%20Class,%20int))([AnnotationNode](../../../../codehaus/groovy/ast/annotationnode) anno, [AnnotatedNode](../../../../codehaus/groovy/ast/annotatednode) node, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<? extends [AnnotatedNode](../../../../codehaus/groovy/ast/annotatednode "AnnotatedNode")> clazz, int originalModifiers)`Determine the correct modifiers by looking for a potential VisibilityOptions: annotation. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### public static int getVisibility([AnnotationNode](../../../../codehaus/groovy/ast/annotationnode) anno, [AnnotatedNode](../../../../codehaus/groovy/ast/annotatednode) node, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<? extends [AnnotatedNode](../../../../codehaus/groovy/ast/annotatednode "AnnotatedNode")> clazz, int originalModifiers) Determine the correct modifiers by looking for a potential VisibilityOptions: annotation. VisibilityOptions: @param clazz The type of node being constructed VisibilityOptions: is found Parameters: `anno` - The annotation being processed (if any) which may support a 'visibilityId' attribute `node` - The node being processed which may also be annotated with `originalModifiers` - The modifier value to adjust or return if no applicable Returns: the updated modifiers groovy [Java] Class ClassNodeUtils [Java] Class ClassNodeUtils =========================== * org.apache.groovy.ast.tools.ClassNodeUtils ``` public class ClassNodeUtils extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Utility class for working with ClassNodes Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public static void` \| `[addDeclaredMethodsFromAllInterfaces](#addDeclaredMethodsFromAllInterfaces(org.codehaus.groovy.ast.ClassNode,%20Map))([ClassNode](../../../../codehaus/groovy/ast/classnode) cNode, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [MethodNode](../../../../codehaus/groovy/ast/methodnode "MethodNode")> methodsMap)`Adds methods from interfaces and parent interfaces. \| \| \| `public static void` \| `[addDeclaredMethodsFromInterfaces](#addDeclaredMethodsFromInterfaces(org.codehaus.groovy.ast.ClassNode,%20Map))([ClassNode](../../../../codehaus/groovy/ast/classnode) cNode, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [MethodNode](../../../../codehaus/groovy/ast/methodnode "MethodNode")> methodsMap)`Adds methods from all interfaces. \| \| \| `public static [ConstructorNode](../../../../codehaus/groovy/ast/constructornode)` \| `[addGeneratedConstructor](#addGeneratedConstructor(org.codehaus.groovy.ast.ClassNode,%20int,%20org.codehaus.groovy.ast.Parameter,%20org.codehaus.groovy.ast.ClassNode,%20org.codehaus.groovy.ast.stmt.Statement))([ClassNode](../../../../codehaus/groovy/ast/classnode) classNode, int modifiers, [Parameter](../../../../codehaus/groovy/ast/parameter)[] parameters, [ClassNode](../../../../codehaus/groovy/ast/classnode)[] exceptions, [Statement](../../../../codehaus/groovy/ast/stmt/statement) code)`Add a method that is marked as `@Generated`. \| \| \| `public static void` \| `[addGeneratedConstructor](#addGeneratedConstructor(org.codehaus.groovy.ast.ClassNode,%20org.codehaus.groovy.ast.ConstructorNode))([ClassNode](../../../../codehaus/groovy/ast/classnode) classNode, [ConstructorNode](../../../../codehaus/groovy/ast/constructornode) consNode)`Add a method that is marked as `@Generated`. \| \| \| `public static void` \| `[addGeneratedInnerClass](#addGeneratedInnerClass(org.codehaus.groovy.ast.ClassNode,%20org.codehaus.groovy.ast.ClassNode))([ClassNode](../../../../codehaus/groovy/ast/classnode) cNode, [ClassNode](../../../../codehaus/groovy/ast/classnode) inner)`Add an inner class that is marked as `@Generated`. \| \| \| `public static [MethodNode](../../../../codehaus/groovy/ast/methodnode)` \| `[addGeneratedMethod](#addGeneratedMethod(org.codehaus.groovy.ast.ClassNode,%20java.lang.String,%20int,%20org.codehaus.groovy.ast.ClassNode,%20org.codehaus.groovy.ast.Parameter,%20org.codehaus.groovy.ast.ClassNode,%20org.codehaus.groovy.ast.stmt.Statement))([ClassNode](../../../../codehaus/groovy/ast/classnode) cNode, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, int modifiers, [ClassNode](../../../../codehaus/groovy/ast/classnode) returnType, [Parameter](../../../../codehaus/groovy/ast/parameter)[] parameters, [ClassNode](../../../../codehaus/groovy/ast/classnode)[] exceptions, [Statement](../../../../codehaus/groovy/ast/stmt/statement) code)`Return an existing method if one exists or else create a new method and mark it as `@Generated`. \| \| \| `public static void` \| `[addGeneratedMethod](#addGeneratedMethod(org.codehaus.groovy.ast.ClassNode,%20org.codehaus.groovy.ast.MethodNode))([ClassNode](../../../../codehaus/groovy/ast/classnode) cNode, [MethodNode](../../../../codehaus/groovy/ast/methodnode) mNode)`Add a method and mark it as `@Generated`. \| \| \| `public static void` \| `[addGeneratedMethod](#addGeneratedMethod(org.codehaus.groovy.ast.ClassNode,%20org.codehaus.groovy.ast.MethodNode,%20boolean))([ClassNode](../../../../codehaus/groovy/ast/classnode) cNode, [MethodNode](../../../../codehaus/groovy/ast/methodnode) mNode, boolean skipChecks)`Add a method and mark it as `@Generated`. \| \| \| `public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[formatTypeName](#formatTypeName(org.codehaus.groovy.ast.ClassNode))([ClassNode](../../../../codehaus/groovy/ast/classnode) cNode)`Formats a type name into a human readable version. \| \| \| `public static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [MethodNode](../../../../codehaus/groovy/ast/methodnode "MethodNode")>` \| `[getDeclaredMethodsFromInterfaces](#getDeclaredMethodsFromInterfaces(org.codehaus.groovy.ast.ClassNode))([ClassNode](../../../../codehaus/groovy/ast/classnode) cNode)`Gets methods from all interfaces. \| \| \| `public static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [MethodNode](../../../../codehaus/groovy/ast/methodnode "MethodNode")>` \| `[getDeclaredMethodsFromSuper](#getDeclaredMethodsFromSuper(org.codehaus.groovy.ast.ClassNode))([ClassNode](../../../../codehaus/groovy/ast/classnode) cNode)`Add methods from the super class. \| \| \| `public static [FieldNode](../../../../codehaus/groovy/ast/fieldnode)` \| `[getField](#getField(org.codehaus.groovy.ast.ClassNode,%20java.lang.String))([ClassNode](../../../../codehaus/groovy/ast/classnode) classNode, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") fieldName)`Searches the class for a field that matches specified name. \| \| \| `public static [FieldNode](../../../../codehaus/groovy/ast/fieldnode)` \| `[getField](#getField(org.codehaus.groovy.ast.ClassNode,%20java.lang.String,%20Predicate))([ClassNode](../../../../codehaus/groovy/ast/classnode) classNode, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") fieldName, [Predicate](https://docs.oracle.com/javase/8/docs/api/java/util/function/Predicate.html "Predicate")<[FieldNode](../../../../codehaus/groovy/ast/fieldnode "FieldNode")> acceptability)`Searches the class for a field that matches specified name and test. \| \| \| `public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getPropNameForAccessor](#getPropNameForAccessor(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") accessorName)`Returns the property name, e.g. age, given an accessor name, e.g. getAge. \| \| \| `public static [PropertyNode](../../../../codehaus/groovy/ast/propertynode)` \| `[getStaticProperty](#getStaticProperty(org.codehaus.groovy.ast.ClassNode,%20java.lang.String))([ClassNode](../../../../codehaus/groovy/ast/classnode) cNode, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") propName)`Detect whether a static property with the given name is within the class or a super class. \| \| \| `public static boolean` \| `[hasExplicitConstructor](#hasExplicitConstructor(org.codehaus.groovy.transform.AbstractASTTransformation,%20org.codehaus.groovy.ast.ClassNode))([AbstractASTTransformation](../../../../codehaus/groovy/transform/abstractasttransformation) xform, [ClassNode](../../../../codehaus/groovy/ast/classnode) cNode)`Determine if an explicit (non-generated) constructor is in the class. \| \| \| `public static boolean` \| `[hasNoArgConstructor](#hasNoArgConstructor(org.codehaus.groovy.ast.ClassNode))([ClassNode](../../../../codehaus/groovy/ast/classnode) cNode)` \| \| \| `public static boolean` \| `[hasPossibleStaticMethod](#hasPossibleStaticMethod(org.codehaus.groovy.ast.ClassNode,%20java.lang.String,%20org.codehaus.groovy.ast.expr.Expression,%20boolean))([ClassNode](../../../../codehaus/groovy/ast/classnode) cNode, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Expression](../../../../codehaus/groovy/ast/expr/expression) arguments, boolean trySpread)`Returns true if the given method has a possibly matching static method with the given name and arguments. \| \| \| `public static boolean` \| `[hasPossibleStaticProperty](#hasPossibleStaticProperty(org.codehaus.groovy.ast.ClassNode,%20java.lang.String))([ClassNode](../../../../codehaus/groovy/ast/classnode) cNode, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName)`Return true if we have a static accessor \| \| \| `public static boolean` \| `[hasStaticProperty](#hasStaticProperty(org.codehaus.groovy.ast.ClassNode,%20java.lang.String))([ClassNode](../../../../codehaus/groovy/ast/classnode) cNode, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") propName)` \| \| \| `public static boolean` \| `[isCompatibleWith](#isCompatibleWith(org.codehaus.groovy.ast.ClassNode,%20org.codehaus.groovy.ast.ClassNode))([ClassNode](../../../../codehaus/groovy/ast/classnode) source, [ClassNode](../../../../codehaus/groovy/ast/classnode) target)`Check if the source ClassNode is compatible with the target ClassNode \| \| \| `public static boolean` \| `[isInnerClass](#isInnerClass(org.codehaus.groovy.ast.ClassNode))([ClassNode](../../../../codehaus/groovy/ast/classnode) cNode)`Detect whether a given ClassNode is a inner class (non-static). \| \| \| `public static boolean` \| `[isValidAccessorName](#isValidAccessorName(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") accessorName)`Detect whether the given accessor name starts with "get", "set" or "is" followed by at least one character. \| \| \| `public static boolean` \| `[samePackageName](#samePackageName(org.codehaus.groovy.ast.ClassNode,%20org.codehaus.groovy.ast.ClassNode))([ClassNode](../../../../codehaus/groovy/ast/classnode) first, [ClassNode](../../../../codehaus/groovy/ast/classnode) second)`Determine if the given ClassNode values have the same package name. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### public static void addDeclaredMethodsFromAllInterfaces([ClassNode](../../../../codehaus/groovy/ast/classnode) cNode, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [MethodNode](../../../../codehaus/groovy/ast/methodnode "MethodNode")> methodsMap) Adds methods from interfaces and parent interfaces. Existing entries in the methods map take precedence. Methods from interfaces visited early take precedence over later ones. Parameters: `cNode` - The ClassNode `methodsMap` - A map of existing methods to alter ### public static void addDeclaredMethodsFromInterfaces([ClassNode](../../../../codehaus/groovy/ast/classnode) cNode, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [MethodNode](../../../../codehaus/groovy/ast/methodnode "MethodNode")> methodsMap) Adds methods from all interfaces. Existing entries in the methods map take precedence. Methods from interfaces visited early take precedence over later ones. Parameters: `cNode` - The ClassNode `methodsMap` - A map of existing methods to alter ### public static [ConstructorNode](../../../../codehaus/groovy/ast/constructornode) addGeneratedConstructor([ClassNode](../../../../codehaus/groovy/ast/classnode) classNode, int modifiers, [Parameter](../../../../codehaus/groovy/ast/parameter)[] parameters, [ClassNode](../../../../codehaus/groovy/ast/classnode)[] exceptions, [Statement](../../../../codehaus/groovy/ast/stmt/statement) code) Add a method that is marked as `@Generated`. See Also: [ClassNode.addConstructor](../../../../codehaus/groovy/ast/classnode#addConstructor(int,%20org.codehaus.groovy.ast.Parameter,%20org.codehaus.groovy.ast.ClassNode,%20java.sql.Statement) "ClassNode.addConstructor") ### public static void addGeneratedConstructor([ClassNode](../../../../codehaus/groovy/ast/classnode) classNode, [ConstructorNode](../../../../codehaus/groovy/ast/constructornode) consNode) Add a method that is marked as `@Generated`. See Also: [ClassNode.addConstructor](../../../../codehaus/groovy/ast/classnode#addConstructor(org.codehaus.groovy.ast.ConstructorNode) "ClassNode.addConstructor") ### public static void addGeneratedInnerClass([ClassNode](../../../../codehaus/groovy/ast/classnode) cNode, [ClassNode](../../../../codehaus/groovy/ast/classnode) inner) Add an inner class that is marked as `@Generated`. See Also: [ModuleNode.addClass](../../../../codehaus/groovy/ast/modulenode#addClass(ClassNode) "ModuleNode.addClass") ### public static [MethodNode](../../../../codehaus/groovy/ast/methodnode) addGeneratedMethod([ClassNode](../../../../codehaus/groovy/ast/classnode) cNode, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, int modifiers, [ClassNode](../../../../codehaus/groovy/ast/classnode) returnType, [Parameter](../../../../codehaus/groovy/ast/parameter)[] parameters, [ClassNode](../../../../codehaus/groovy/ast/classnode)[] exceptions, [Statement](../../../../codehaus/groovy/ast/stmt/statement) code) Return an existing method if one exists or else create a new method and mark it as `@Generated`. See Also: [ClassNode.addMethod](../../../../codehaus/groovy/ast/classnode#addMethod(java.lang.String,%20int,%20org.codehaus.groovy.ast.ClassNode,%20org.codehaus.groovy.ast.Parameter,%20org.codehaus.groovy.ast.ClassNode,%20java.sql.Statement) "ClassNode.addMethod") ### public static void addGeneratedMethod([ClassNode](../../../../codehaus/groovy/ast/classnode) cNode, [MethodNode](../../../../codehaus/groovy/ast/methodnode) mNode) Add a method and mark it as `@Generated`. See Also: [ClassNode.addMethod](../../../../codehaus/groovy/ast/classnode#addMethod(org.codehaus.groovy.ast.MethodNode) "ClassNode.addMethod") ### public static void addGeneratedMethod([ClassNode](../../../../codehaus/groovy/ast/classnode) cNode, [MethodNode](../../../../codehaus/groovy/ast/methodnode) mNode, boolean skipChecks) Add a method and mark it as `@Generated`. See Also: [ClassNode.addMethod](../../../../codehaus/groovy/ast/classnode#addMethod(org.codehaus.groovy.ast.MethodNode) "ClassNode.addMethod") ### public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") formatTypeName([ClassNode](../../../../codehaus/groovy/ast/classnode) cNode) Formats a type name into a human readable version. For arrays, appends "[]" to the formatted type name of the component. For unit class nodes, uses the class node name. Parameters: `cNode` - the type to format Returns: a human readable version of the type name (java.lang.String[] for example) ### public static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [MethodNode](../../../../codehaus/groovy/ast/methodnode "MethodNode")> getDeclaredMethodsFromInterfaces([ClassNode](../../../../codehaus/groovy/ast/classnode) cNode) Gets methods from all interfaces. Methods from interfaces visited early take precedence over later ones. Parameters: `cNode` - The ClassNode Returns: A map of methods ### public static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [MethodNode](../../../../codehaus/groovy/ast/methodnode "MethodNode")> getDeclaredMethodsFromSuper([ClassNode](../../../../codehaus/groovy/ast/classnode) cNode) Add methods from the super class. Parameters: `cNode` - The ClassNode Returns: A map of methods ### public static [FieldNode](../../../../codehaus/groovy/ast/fieldnode) getField([ClassNode](../../../../codehaus/groovy/ast/classnode) classNode, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") fieldName) Searches the class for a field that matches specified name. ### public static [FieldNode](../../../../codehaus/groovy/ast/fieldnode) getField([ClassNode](../../../../codehaus/groovy/ast/classnode) classNode, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") fieldName, [Predicate](https://docs.oracle.com/javase/8/docs/api/java/util/function/Predicate.html "Predicate")<[FieldNode](../../../../codehaus/groovy/ast/fieldnode "FieldNode")> acceptability) Searches the class for a field that matches specified name and test. ### public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getPropNameForAccessor([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") accessorName) Returns the property name, e.g. age, given an accessor name, e.g. getAge. Returns the original if a valid prefix cannot be removed. Parameters: `accessorName` - the accessor name of interest, e.g. getAge Returns: the property name, e.g. age, or original if not a valid property accessor name ### public static [PropertyNode](../../../../codehaus/groovy/ast/propertynode) getStaticProperty([ClassNode](../../../../codehaus/groovy/ast/classnode) cNode, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") propName) Detect whether a static property with the given name is within the class or a super class. Parameters: `cNode` - the ClassNode of interest `propName` - the property name Returns: the static property if found or else null ### public static boolean hasExplicitConstructor([AbstractASTTransformation](../../../../codehaus/groovy/transform/abstractasttransformation) xform, [ClassNode](../../../../codehaus/groovy/ast/classnode) cNode) Determine if an explicit (non-generated) constructor is in the class. Parameters: `xform` - if non null, add an error if an explicit constructor is found `cNode` - the type of the containing class Returns: true if an explicit (non-generated) constructor was found ### public static boolean hasNoArgConstructor([ClassNode](../../../../codehaus/groovy/ast/classnode) cNode) ### public static boolean hasPossibleStaticMethod([ClassNode](../../../../codehaus/groovy/ast/classnode) cNode, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Expression](../../../../codehaus/groovy/ast/expr/expression) arguments, boolean trySpread) Returns true if the given method has a possibly matching static method with the given name and arguments. Handles default arguments and optionally spread expressions. Parameters: `cNode` - the ClassNode of interest `name` - the name of the method of interest `arguments` - the arguments to match against `trySpread` - whether to try to account for SpreadExpressions within the arguments Returns: true if a matching method was found ### public static boolean hasPossibleStaticProperty([ClassNode](../../../../codehaus/groovy/ast/classnode) cNode, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName) Return true if we have a static accessor ### public static boolean hasStaticProperty([ClassNode](../../../../codehaus/groovy/ast/classnode) cNode, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") propName) ### public static boolean isCompatibleWith([ClassNode](../../../../codehaus/groovy/ast/classnode) source, [ClassNode](../../../../codehaus/groovy/ast/classnode) target) Check if the source ClassNode is compatible with the target ClassNode ### public static boolean isInnerClass([ClassNode](../../../../codehaus/groovy/ast/classnode) cNode) Detect whether a given ClassNode is a inner class (non-static). Parameters: `cNode` - the ClassNode of interest Returns: true if the given node is a (non-static) inner class, else false ### public static boolean isValidAccessorName([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") accessorName) Detect whether the given accessor name starts with "get", "set" or "is" followed by at least one character. Parameters: `accessorName` - the accessor name of interest, e.g. getAge Returns: true if a valid prefix is found ### public static boolean samePackageName([ClassNode](../../../../codehaus/groovy/ast/classnode) first, [ClassNode](../../../../codehaus/groovy/ast/classnode) second) Determine if the given ClassNode values have the same package name. throws: NullPointerException if either of the given nodes are null Parameters: `first` - a ClassNode `second` - a ClassNode Returns: true if both given nodes have the same package name	programming_docs
groovy [Java] Class AstBuilderTransformation [Java] Class AstBuilderTransformation ===================================== * org.apache.groovy.ast.builder.AstBuilderTransformation ``` @[GroovyASTTransformation](../../../../codehaus/groovy/transform/groovyasttransformation "GroovyASTTransformation")(phase = CompilePhase.SEMANTIC_ANALYSIS) public class AstBuilderTransformation extends [MethodCallTransformation](../../../../codehaus/groovy/ast/methodcalltransformation) ``` Transformation to capture ASTBuilder from code statements. The AstBuilder "from code" approach is used with a single Closure parameter. This transformation converts the ClosureExpression back into source code and rewrites the AST so that the "from string" builder is invoked on the source. In order for this to work, the closure source must be given a goto label. It is the "from string" approach's responsibility to remove the BlockStatement created by the label. Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `protected [GroovyCodeVisitor](../../../../codehaus/groovy/ast/groovycodevisitor)` \| `[getTransformer](#getTransformer(org.codehaus.groovy.ast.ASTNode,%20org.codehaus.groovy.control.SourceUnit))([ASTNode](../../../../codehaus/groovy/ast/astnode)[] nodes, [SourceUnit](../../../../codehaus/groovy/control/sourceunit) sourceUnit)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [MethodCallTransformation](../../../../codehaus/groovy/ast/methodcalltransformation)` \| `[getTransformer](../../../../codehaus/groovy/ast/methodcalltransformation#getTransformer(org.codehaus.groovy.ast.ASTNode,%20org.codehaus.groovy.control.SourceUnit)), [visit](../../../../codehaus/groovy/ast/methodcalltransformation#visit(org.codehaus.groovy.ast.ASTNode,%20org.codehaus.groovy.control.SourceUnit))` \| Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected [GroovyCodeVisitor](../../../../codehaus/groovy/ast/groovycodevisitor) getTransformer([ASTNode](../../../../codehaus/groovy/ast/astnode)[] nodes, [SourceUnit](../../../../codehaus/groovy/control/sourceunit) sourceUnit) groovy [Java] Class WritablePath [Java] Class WritablePath ========================= * org.apache.groovy.nio.runtime.WritablePath All Implemented Interfaces and Traits: [Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path"), [Writable](../../../../../groovy/lang/writable) ``` public class WritablePath extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") implements [Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path"), [Writable](../../../../../groovy/lang/writable) ``` A Writable Path. Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[WritablePath](#WritablePath(java.nio.file.Path))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") delegate)` \| \| `[WritablePath](#WritablePath(java.nio.file.Path,%20java.lang.String))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") delegate, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") encoding)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public int` \| `[compareTo](#compareTo(java.nio.file.Path))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") other)` \| \| \| `public boolean` \| `[endsWith](#endsWith(java.nio.file.Path))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") other)` \| \| \| `public boolean` \| `[endsWith](#endsWith(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") other)` \| \| \| `public boolean` \| `[equals](#equals(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") other)` \| \| \| `public [Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path")` \| `[getFileName](#getFileName())()` \| \| \| `public [FileSystem](https://docs.oracle.com/javase/8/docs/api/java/nio/file/FileSystem.html "FileSystem")` \| `[getFileSystem](#getFileSystem())()` \| \| \| `public [Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path")` \| `[getName](#getName(int))(int index)` \| \| \| `public int` \| `[getNameCount](#getNameCount())()` \| \| \| `public [Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path")` \| `[getParent](#getParent())()` \| \| \| `public [Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path")` \| `[getRoot](#getRoot())()` \| \| \| `public int` \| `[hashCode](#hashCode())()` \| \| \| `public boolean` \| `[isAbsolute](#isAbsolute())()` \| \| \| `public [Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html "Iterator")<[Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path")>` \| `[iterator](#iterator())()` \| \| \| `public [Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path")` \| `[normalize](#normalize())()` \| \| \| `public [WatchKey](https://docs.oracle.com/javase/8/docs/api/java/nio/file/WatchKey.html "WatchKey")` \| `[register](#register(java.nio.file.WatchService,%20WatchEvent.Kind,%20java.nio.file.WatchEvent%24Modifier))([WatchService](https://docs.oracle.com/javase/8/docs/api/java/nio/file/WatchService.html "WatchService") watcher, WatchEvent.Kind<?>[] events, [WatchEvent.Modifier](https://docs.oracle.com/javase/8/docs/api/java/nio/file/WatchEvent.Modifier.html "WatchEvent.Modifier") modifiers)` \| \| \| `public [WatchKey](https://docs.oracle.com/javase/8/docs/api/java/nio/file/WatchKey.html "WatchKey")` \| `[register](#register(java.nio.file.WatchService,%20WatchEvent.Kind))([WatchService](https://docs.oracle.com/javase/8/docs/api/java/nio/file/WatchService.html "WatchService") watcher, WatchEvent.Kind<?> events)` \| \| \| `public [Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path")` \| `[relativize](#relativize(java.nio.file.Path))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") other)` \| \| \| `public [Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path")` \| `[resolve](#resolve(java.nio.file.Path))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") other)` \| \| \| `public [Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path")` \| `[resolve](#resolve(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") other)` \| \| \| `public [Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path")` \| `[resolveSibling](#resolveSibling(java.nio.file.Path))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") other)` \| \| \| `public [Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path")` \| `[resolveSibling](#resolveSibling(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") other)` \| \| \| `public boolean` \| `[startsWith](#startsWith(java.nio.file.Path))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") other)` \| \| \| `public boolean` \| `[startsWith](#startsWith(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") other)` \| \| \| `public [Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path")` \| `[subpath](#subpath(int,%20int))(int beginIndex, int endIndex)` \| \| \| `public [Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path")` \| `[toAbsolutePath](#toAbsolutePath())()` \| \| \| `public [File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File")` \| `[toFile](#toFile())()` \| \| \| `public [Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path")` \| `[toRealPath](#toRealPath(java.nio.file.LinkOption))([LinkOption](https://docs.oracle.com/javase/8/docs/api/java/nio/file/LinkOption.html "LinkOption") options)` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[toString](#toString())()` \| \| \| `public [URI](https://docs.oracle.com/javase/8/docs/api/java/net/URI.html "URI")` \| `[toUri](#toUri())()` \| \| \| `public [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer")` \| `[writeTo](#writeTo(java.io.Writer))([Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") out)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public WritablePath([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") delegate) ### public WritablePath([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") delegate, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") encoding) Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public int compareTo([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") other) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean endsWith([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") other) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean endsWith([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") other) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean equals([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") other) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") getFileName() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [FileSystem](https://docs.oracle.com/javase/8/docs/api/java/nio/file/FileSystem.html "FileSystem") getFileSystem() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") getName(int index) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public int getNameCount() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") getParent() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") getRoot() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public int hashCode() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean isAbsolute() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html "Iterator")<[Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path")> iterator() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") normalize() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [WatchKey](https://docs.oracle.com/javase/8/docs/api/java/nio/file/WatchKey.html "WatchKey") register([WatchService](https://docs.oracle.com/javase/8/docs/api/java/nio/file/WatchService.html "WatchService") watcher, WatchEvent.Kind<?>[] events, [WatchEvent.Modifier](https://docs.oracle.com/javase/8/docs/api/java/nio/file/WatchEvent.Modifier.html "WatchEvent.Modifier") modifiers) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [WatchKey](https://docs.oracle.com/javase/8/docs/api/java/nio/file/WatchKey.html "WatchKey") register([WatchService](https://docs.oracle.com/javase/8/docs/api/java/nio/file/WatchService.html "WatchService") watcher, WatchEvent.Kind<?> events) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") relativize([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") other) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") resolve([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") other) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") resolve([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") other) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") resolveSibling([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") other) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") resolveSibling([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") other) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean startsWith([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") other) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean startsWith([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") other) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") subpath(int beginIndex, int endIndex) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") toAbsolutePath() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File") toFile() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") toRealPath([LinkOption](https://docs.oracle.com/javase/8/docs/api/java/nio/file/LinkOption.html "LinkOption") options) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") toString() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [URI](https://docs.oracle.com/javase/8/docs/api/java/net/URI.html "URI") toUri() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") writeTo([Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") out) groovy [Java] Class NioExtensions [Java] Class NioExtensions ========================== * org.apache.groovy.nio.extensions.NioExtensions ``` public class NioExtensions extends [DefaultGroovyMethodsSupport](../../../../codehaus/groovy/runtime/defaultgroovymethodssupport) ``` This class defines new groovy methods for Readers, Writers, InputStreams and OutputStreams which appear on normal JDK classes inside the Groovy environment. Static methods are used with the first parameter being the destination class, i.e. `public static T eachLine(InputStream self, Closure c)` provides a `eachLine(Closure c)` method for `InputStream`. NOTE: While this class contains many 'public' static methods, it is primarily regarded as an internal class (its internal package name suggests this also). We value backwards compatibility of these methods when used within Groovy but value less backwards compatibility at the Java method call level. I.e. future versions of Groovy may remove or move a method call in this file but would normally aim to keep the method available from within Groovy. Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public static void` \| `[append](#append(java.nio.file.Path,%20java.lang.Object))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") text)`Append the text at the end of the Path without writing a BOM. \| \| \| `public static void` \| `[append](#append(java.nio.file.Path,%20java.io.Reader))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") file, [Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") reader)`Append the text supplied by the Writer at the end of the File without writing a BOM. \| \| \| `public static void` \| `[append](#append(java.nio.file.Path,%20java.io.Writer))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") file, [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") writer)`Append the text supplied by the Writer at the end of the File without writing a BOM. \| \| \| `public static void` \| `[append](#append(java.nio.file.Path,%20byte%5B%5D))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, byte[] bytes)`Append bytes to the end of a Path. \| \| \| `public static void` \| `[append](#append(java.nio.file.Path,%20java.io.InputStream))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [InputStream](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html "InputStream") stream)`Append binary data to the file. \| \| \| `public static void` \| `[append](#append(java.nio.file.Path,%20java.lang.Object,%20boolean))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") text, boolean writeBom)`Append the text at the end of the Path. \| \| \| `public static void` \| `[append](#append(java.nio.file.Path,%20java.lang.Object,%20java.lang.String))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") text, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset)`Append the text at the end of the Path without writing a BOM, using a specified encoding. \| \| \| `public static void` \| `[append](#append(java.nio.file.Path,%20java.lang.Object,%20java.lang.String,%20boolean))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") text, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset, boolean writeBom)`Append the text at the end of the Path, using a specified encoding. \| \| \| `public static void` \| `[append](#append(java.nio.file.Path,%20java.io.Writer,%20boolean))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") file, [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") writer, boolean writeBom)`Append the text supplied by the Writer at the end of the File, using a specified encoding. \| \| \| `public static void` \| `[append](#append(java.nio.file.Path,%20java.io.Writer,%20java.lang.String))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") file, [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") writer, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset)`Append the text supplied by the Writer at the end of the File without writing a BOM, using a specified encoding. \| \| \| `public static void` \| `[append](#append(java.nio.file.Path,%20java.io.Writer,%20java.lang.String,%20boolean))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") file, [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") writer, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset, boolean writeBom)`Append the text supplied by the Writer at the end of the File, using a specified encoding. \| \| \| `public static void` \| `[append](#append(java.nio.file.Path,%20java.io.Reader,%20boolean))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") file, [Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") reader, boolean writeBom)`Append the text supplied by the Reader at the end of the File, using a specified encoding. \| \| \| `public static void` \| `[append](#append(java.nio.file.Path,%20java.io.Reader,%20java.lang.String))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") file, [Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") reader, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset)`Append the text supplied by the Reader at the end of the File without writing a BOM, using a specified encoding. \| \| \| `public static void` \| `[append](#append(java.nio.file.Path,%20java.io.Reader,%20java.lang.String,%20boolean))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") file, [Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") reader, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset, boolean writeBom)`Append the text supplied by the Reader at the end of the File, using a specified encoding. \| \| `<T>` \| `public static T` \| `[asType](#asType(java.nio.file.Path,%20Class))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") path, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<T> c)`Converts this Path to a [Writable](../../../../../groovy/lang/writable "Writable") or delegates to default [DefaultGroovyMethods.asType](../../../../codehaus/groovy/runtime/defaultgroovymethods#asType(Object,%20Class) "DefaultGroovyMethods.asType"). \| \| \| `public static [Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path")` \| `[asWritable](#asWritable(java.nio.file.Path))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self)`Converts this Path to a [Writable](../../../../../groovy/lang/writable "Writable"). \| \| \| `public static [Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path")` \| `[asWritable](#asWritable(java.nio.file.Path,%20java.lang.String))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") encoding)`Allows a file to return a Writable implementation that can output itself to a Writer stream. \| \| \| `public static [Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path")` \| `[createParentDirectories](#createParentDirectories(java.nio.file.Path,%20FileAttribute))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [FileAttribute](https://docs.oracle.com/javase/8/docs/api/java/nio/file/attribute/FileAttribute.html "FileAttribute")<?> attrs)`Creates, if needed, any parent directories for the file associated with this Path. \| \| \| `public static boolean` \| `[deleteDir](#deleteDir(java.nio.file.Path))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self)`Deletes a directory with all contained files and subdirectories. \| \| \| `public static void` \| `[eachByte](#eachByte(java.nio.file.Path,%20groovy.lang.Closure))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [Closure](../../../../../groovy/lang/closure) closure)`Traverse through each byte of this Path \| \| \| `public static void` \| `[eachByte](#eachByte(java.nio.file.Path,%20int,%20groovy.lang.Closure))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, int bufferLen, [Closure](../../../../../groovy/lang/closure) closure)`Traverse through the bytes of this Path, bufferLen bytes at a time. \| \| \| `public static void` \| `[eachDir](#eachDir(java.nio.file.Path,%20groovy.lang.Closure))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [Closure](../../../../../groovy/lang/closure) closure)`Invokes the closure for each subdirectory in this directory, ignoring regular files. \| \| \| `public static void` \| `[eachDirMatch](#eachDirMatch(java.nio.file.Path,%20java.lang.Object,%20groovy.lang.Closure))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") nameFilter, [Closure](../../../../../groovy/lang/closure) closure)`Invokes the closure for each subdirectory whose name (dir.name) matches the given nameFilter in the given directory - calling the DefaultGroovyMethods#isCase(java.lang.Object, java.lang.Object) method to determine if a match occurs. \| \| \| `public static void` \| `[eachDirRecurse](#eachDirRecurse(java.nio.file.Path,%20groovy.lang.Closure))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [Closure](../../../../../groovy/lang/closure) closure)`Recursively processes each descendant subdirectory in this directory. \| \| \| `public static void` \| `[eachFile](#eachFile(java.nio.file.Path,%20groovy.io.FileType,%20groovy.lang.Closure))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [FileType](../../../../../groovy/io/filetype) fileType, [Closure](../../../../../groovy/lang/closure) closure)`Invokes the closure for each 'child' file in this 'parent' folder/directory. \| \| \| `public static void` \| `[eachFile](#eachFile(java.nio.file.Path,%20groovy.lang.Closure))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [Closure](../../../../../groovy/lang/closure) closure)`Invokes the closure for each 'child' file in this 'parent' folder/directory. \| \| \| `public static void` \| `[eachFileMatch](#eachFileMatch(java.nio.file.Path,%20groovy.io.FileType,%20java.lang.Object,%20groovy.lang.Closure))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [FileType](../../../../../groovy/io/filetype) fileType, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") nameFilter, [Closure](../../../../../groovy/lang/closure) closure)`Invokes the closure for each file whose name (file.name) matches the given nameFilter in the given directory - calling the [DefaultGroovyMethods.isCase](../../../../codehaus/groovy/runtime/defaultgroovymethods#isCase(Object,%20Object) "DefaultGroovyMethods.isCase") method to determine if a match occurs. \| \| \| `public static void` \| `[eachFileMatch](#eachFileMatch(java.nio.file.Path,%20java.lang.Object,%20groovy.lang.Closure))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") nameFilter, [Closure](../../../../../groovy/lang/closure) closure)`Invokes the closure for each file whose name (file.name) matches the given nameFilter in the given directory - calling the [DefaultGroovyMethods.isCase](../../../../codehaus/groovy/runtime/defaultgroovymethods#isCase(Object,%20Object) "DefaultGroovyMethods.isCase") method to determine if a match occurs. \| \| \| `public static void` \| `[eachFileRecurse](#eachFileRecurse(java.nio.file.Path,%20groovy.io.FileType,%20groovy.lang.Closure))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [FileType](../../../../../groovy/io/filetype) fileType, [Closure](../../../../../groovy/lang/closure) closure)`Processes each descendant file in this directory and any sub-directories. \| \| \| `public static void` \| `[eachFileRecurse](#eachFileRecurse(java.nio.file.Path,%20groovy.lang.Closure))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [Closure](../../../../../groovy/lang/closure) closure)`Processes each descendant file in this directory and any sub-directories. \| \| `<T>` \| `public static T` \| `[eachLine](#eachLine(java.nio.file.Path,%20Closure))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [Closure](../../../../../groovy/lang/closure "Closure")<T> closure)`Iterates through this path line by line. \| \| `<T>` \| `public static T` \| `[eachLine](#eachLine(java.nio.file.Path,%20java.lang.String,%20Closure))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset, [Closure](../../../../../groovy/lang/closure "Closure")<T> closure)`Iterates through this file line by line. \| \| `<T>` \| `public static T` \| `[eachLine](#eachLine(java.nio.file.Path,%20int,%20Closure))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, int firstLine, [Closure](../../../../../groovy/lang/closure "Closure")<T> closure)`Iterates through this file line by line. \| \| `<T>` \| `public static T` \| `[eachLine](#eachLine(java.nio.file.Path,%20java.lang.String,%20int,%20Closure))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset, int firstLine, [Closure](../../../../../groovy/lang/closure "Closure")<T> closure)`Iterates through this file line by line. \| \| \| `public static void` \| `[eachObject](#eachObject(java.nio.file.Path,%20groovy.lang.Closure))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [Closure](../../../../../groovy/lang/closure) closure)`Iterates through the given file object by object. \| \| \| `public static [Writable](../../../../../groovy/lang/writable)` \| `[filterLine](#filterLine(java.nio.file.Path,%20groovy.lang.Closure))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [Closure](../../../../../groovy/lang/closure) closure)`Filters the lines of a Path and creates a Writable in return to stream the filtered lines. \| \| \| `public static [Writable](../../../../../groovy/lang/writable)` \| `[filterLine](#filterLine(java.nio.file.Path,%20java.lang.String,%20groovy.lang.Closure))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset, [Closure](../../../../../groovy/lang/closure) closure)`Filters the lines of a Path and creates a Writable in return to stream the filtered lines. \| \| \| `public static void` \| `[filterLine](#filterLine(java.nio.file.Path,%20java.io.Writer,%20groovy.lang.Closure))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") writer, [Closure](../../../../../groovy/lang/closure) closure)`Filter the lines from this Path, and write them to the given writer based on the given closure predicate. \| \| \| `public static void` \| `[filterLine](#filterLine(java.nio.file.Path,%20java.io.Writer,%20java.lang.String,%20groovy.lang.Closure))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") writer, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset, [Closure](../../../../../groovy/lang/closure) closure)`Filter the lines from this Path, and write them to the given writer based on the given closure predicate. \| \| \| `public static byte[]` \| `[getBytes](#getBytes(java.nio.file.Path))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self)`Read the content of the Path and returns it as a byte[]. \| \| \| `public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getText](#getText(java.nio.file.Path,%20java.lang.String))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset)`Read the content of the Path using the specified encoding and return it as a String. \| \| \| `public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getText](#getText(java.nio.file.Path))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self)`Read the content of the Path and returns it as a String. \| \| \| `public static [Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path")` \| `[leftShift](#leftShift(java.nio.file.Path,%20java.lang.Object))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") text)`Write the text to the Path. \| \| \| `public static [Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path")` \| `[leftShift](#leftShift(java.nio.file.Path,%20byte%5B%5D))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, byte[] bytes)`Write bytes to a Path. \| \| \| `public static [Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path")` \| `[leftShift](#leftShift(java.nio.file.Path,%20java.io.InputStream))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") path, [InputStream](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html "InputStream") data)`Append binary data to the file. \| \| \| `public static [DataInputStream](https://docs.oracle.com/javase/8/docs/api/java/io/DataInputStream.html "DataInputStream")` \| `[newDataInputStream](#newDataInputStream(java.nio.file.Path))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self)`Create a data input stream for this file \| \| \| `public static [DataOutputStream](https://docs.oracle.com/javase/8/docs/api/java/io/DataOutputStream.html "DataOutputStream")` \| `[newDataOutputStream](#newDataOutputStream(java.nio.file.Path))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self)`Creates a new data output stream for this file. \| \| \| `public static [BufferedInputStream](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedInputStream.html "BufferedInputStream")` \| `[newInputStream](#newInputStream(java.nio.file.Path))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self)`Creates a buffered input stream for this file. \| \| \| `public static [ObjectInputStream](https://docs.oracle.com/javase/8/docs/api/java/io/ObjectInputStream.html "ObjectInputStream")` \| `[newObjectInputStream](#newObjectInputStream(java.nio.file.Path))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self)`Create an object input stream for this file. \| \| \| `public static [ObjectInputStream](https://docs.oracle.com/javase/8/docs/api/java/io/ObjectInputStream.html "ObjectInputStream")` \| `[newObjectInputStream](#newObjectInputStream(java.nio.file.Path,%20java.lang.ClassLoader))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html "ClassLoader") classLoader)`Create an object input stream for this path using the given class loader. \| \| \| `public static [ObjectOutputStream](https://docs.oracle.com/javase/8/docs/api/java/io/ObjectOutputStream.html "ObjectOutputStream")` \| `[newObjectOutputStream](#newObjectOutputStream(java.nio.file.Path))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self)`Create an object output stream for this path. \| \| \| `public static [BufferedOutputStream](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedOutputStream.html "BufferedOutputStream")` \| `[newOutputStream](#newOutputStream(java.nio.file.Path))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self)`Create a buffered output stream for this file. \| \| \| `public static [PrintWriter](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html "PrintWriter")` \| `[newPrintWriter](#newPrintWriter(java.nio.file.Path))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self)`Create a new PrintWriter for this file. \| \| \| `public static [PrintWriter](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html "PrintWriter")` \| `[newPrintWriter](#newPrintWriter(java.nio.file.Path,%20java.lang.String))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset)`Create a new PrintWriter for this file, using specified charset. \| \| \| `public static [BufferedReader](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedReader.html "BufferedReader")` \| `[newReader](#newReader(java.nio.file.Path))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self)`Create a buffered reader for this file. \| \| \| `public static [BufferedReader](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedReader.html "BufferedReader")` \| `[newReader](#newReader(java.nio.file.Path,%20java.lang.String))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset)`Create a buffered reader for this file, using the specified charset as the encoding. \| \| \| `public static [BufferedWriter](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedWriter.html "BufferedWriter")` \| `[newWriter](#newWriter(java.nio.file.Path))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self)`Create a buffered writer for this file. \| \| \| `public static [BufferedWriter](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedWriter.html "BufferedWriter")` \| `[newWriter](#newWriter(java.nio.file.Path,%20boolean))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, boolean append)`Creates a buffered writer for this file, optionally appending to the existing file content. \| \| \| `public static [BufferedWriter](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedWriter.html "BufferedWriter")` \| `[newWriter](#newWriter(java.nio.file.Path,%20java.lang.String,%20boolean))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset, boolean append)`Helper method to create a buffered writer for a file without writing a BOM. \| \| \| `public static [BufferedWriter](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedWriter.html "BufferedWriter")` \| `[newWriter](#newWriter(java.nio.file.Path,%20java.lang.String,%20boolean,%20boolean))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset, boolean append, boolean writeBom)`Helper method to create a buffered writer for a file. \| \| \| `public static [BufferedWriter](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedWriter.html "BufferedWriter")` \| `[newWriter](#newWriter(java.nio.file.Path,%20java.lang.String))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset)`Creates a buffered writer for this file without writing a BOM, writing data using the given encoding. \| \| \| `public static byte[]` \| `[readBytes](#readBytes(java.nio.file.Path))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self)`Reads the content of the file into a byte array. \| \| \| `public static [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>` \| `[readLines](#readLines(java.nio.file.Path))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self)`Reads the file into a list of Strings, with one item for each line. \| \| \| `public static [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>` \| `[readLines](#readLines(java.nio.file.Path,%20java.lang.String))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset)`Reads the file into a list of Strings, with one item for each line. \| \| \| `public static boolean` \| `[renameTo](#renameTo(java.nio.file.Path,%20java.lang.String))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") newPathName)`Renames a file. \| \| \| `public static boolean` \| `[renameTo](#renameTo(java.nio.file.Path,%20java.net.URI))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [URI](https://docs.oracle.com/javase/8/docs/api/java/net/URI.html "URI") newPathName)`Renames a file. \| \| \| `public static void` \| `[setBytes](#setBytes(java.nio.file.Path,%20byte%5B%5D))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, byte[] bytes)`Write the bytes from the byte array to the Path. \| \| \| `public static void` \| `[setText](#setText(java.nio.file.Path,%20java.lang.String))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text)`Synonym for write(text) allowing file.text = 'foo'. \| \| \| `public static void` \| `[setText](#setText(java.nio.file.Path,%20java.lang.String,%20java.lang.String))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset)`Synonym for write(text, charset) allowing: ``` myFile.setText('some text', charset) ``` or with some help from `ExpandoMetaClass`, you could do something like: ``` myFile.metaClass.setText = { String s -> delegate.setText(s, 'UTF-8') } myfile.text = 'some text' ``` \| \| \| `public static long` \| `[size](#size(java.nio.file.Path))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self)`Provide the standard Groovy `size()` method for `Path`. \| \| `<T>` \| `public static T` \| `[splitEachLine](#splitEachLine(java.nio.file.Path,%20java.lang.String,%20Closure))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") regex, [Closure](../../../../../groovy/lang/closure "Closure")<T> closure)`Iterates through this file line by line, splitting each line using the given regex separator. \| \| `<T>` \| `public static T` \| `[splitEachLine](#splitEachLine(java.nio.file.Path,%20java.util.regex.Pattern,%20Closure))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [Pattern](https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html "Pattern") pattern, [Closure](../../../../../groovy/lang/closure "Closure")<T> closure)`Iterates through this file line by line, splitting each line using the given separator Pattern. \| \| `<T>` \| `public static T` \| `[splitEachLine](#splitEachLine(java.nio.file.Path,%20java.lang.String,%20java.lang.String,%20Closure))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") regex, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset, [Closure](../../../../../groovy/lang/closure "Closure")<T> closure)`Iterates through this file line by line, splitting each line using the given regex separator. \| \| `<T>` \| `public static T` \| `[splitEachLine](#splitEachLine(java.nio.file.Path,%20java.util.regex.Pattern,%20java.lang.String,%20Closure))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [Pattern](https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html "Pattern") pattern, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset, [Closure](../../../../../groovy/lang/closure "Closure")<T> closure)`Iterates through this file line by line, splitting each line using the given regex separator Pattern. \| \| \| `public static void` \| `[traverse](#traverse(java.nio.file.Path,%20Map,%20groovy.lang.Closure))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")> options, [Closure](../../../../../groovy/lang/closure) closure)`Processes each descendant file in this directory and any sub-directories. \| \| \| `public static void` \| `[traverse](#traverse(java.nio.file.Path,%20groovy.lang.Closure))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [Closure](../../../../../groovy/lang/closure) closure)`Processes each descendant file in this directory and any sub-directories. \| \| \| `public static void` \| `[traverse](#traverse(java.nio.file.Path,%20Map))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")> options)`Invokes the closure specified with key 'visit' in the options Map for each descendant file in this directory tree. \| \| `<T>` \| `public static T` \| `[withCloseable](#withCloseable(java.io.Closeable,%20Closure))([Closeable](https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html "Closeable") self, [Closure](../../../../../groovy/lang/closure "Closure")<T> action)`#deprecated use the variant in IOGroovyMethods \| \| `<T>` \| `public static T` \| `[withDataInputStream](#withDataInputStream(java.nio.file.Path,%20Closure))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [Closure](../../../../../groovy/lang/closure "Closure")<T> closure)`Create a new DataInputStream for this file and passes it into the closure. \| \| `<T>` \| `public static T` \| `[withDataOutputStream](#withDataOutputStream(java.nio.file.Path,%20Closure))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [Closure](../../../../../groovy/lang/closure "Closure")<T> closure)`Create a new DataOutputStream for this file and passes it into the closure. \| \| `<T>` \| `public static T` \| `[withInputStream](#withInputStream(java.nio.file.Path,%20Closure))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [Closure](../../../../../groovy/lang/closure "Closure")<T> closure)`Create a new InputStream for this file and passes it into the closure. \| \| `<T>` \| `public static T` \| `[withObjectInputStream](#withObjectInputStream(java.nio.file.Path,%20Closure))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") path, [Closure](../../../../../groovy/lang/closure "Closure")<T> closure)`Create a new ObjectInputStream for this file and pass it to the closure. \| \| `<T>` \| `public static T` \| `[withObjectInputStream](#withObjectInputStream(java.nio.file.Path,%20java.lang.ClassLoader,%20Closure))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html "ClassLoader") classLoader, [Closure](../../../../../groovy/lang/closure "Closure")<T> closure)`Create a new ObjectInputStream for this file associated with the given class loader and pass it to the closure. \| \| `<T>` \| `public static T` \| `[withObjectOutputStream](#withObjectOutputStream(java.nio.file.Path,%20Closure))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [Closure](../../../../../groovy/lang/closure "Closure")<T> closure)`Create a new ObjectOutputStream for this path and then pass it to the closure. \| \| `<T>` \| `public static T` \| `[withOutputStream](#withOutputStream(java.nio.file.Path,%20Closure))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [Closure](../../../../../groovy/lang/closure "Closure")<T> closure)`Creates a new OutputStream for this file and passes it into the closure. \| \| `<T>` \| `public static T` \| `[withPrintWriter](#withPrintWriter(java.nio.file.Path,%20Closure))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [Closure](../../../../../groovy/lang/closure "Closure")<T> closure)`Create a new PrintWriter for this file which is then passed it into the given closure. \| \| `<T>` \| `public static T` \| `[withPrintWriter](#withPrintWriter(java.nio.file.Path,%20java.lang.String,%20Closure))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset, [Closure](../../../../../groovy/lang/closure "Closure")<T> closure)`Create a new PrintWriter with a specified charset for this file. \| \| `<T>` \| `public static T` \| `[withReader](#withReader(java.nio.file.Path,%20Closure))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [Closure](../../../../../groovy/lang/closure "Closure")<T> closure)`Create a new BufferedReader for this file and then passes it into the closure, ensuring the reader is closed after the closure returns. \| \| `<T>` \| `public static T` \| `[withReader](#withReader(java.nio.file.Path,%20java.lang.String,%20Closure))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset, [Closure](../../../../../groovy/lang/closure "Closure")<T> closure)`Create a new BufferedReader for this file using the specified charset and then passes it into the closure, ensuring the reader is closed after the closure returns. \| \| `<T>` \| `public static T` \| `[withWriter](#withWriter(java.nio.file.Path,%20Closure))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [Closure](../../../../../groovy/lang/closure "Closure")<T> closure)`Creates a new BufferedWriter for this file, passes it to the closure, and ensures the stream is flushed and closed after the closure returns. \| \| `<T>` \| `public static T` \| `[withWriter](#withWriter(java.nio.file.Path,%20java.lang.String,%20Closure))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset, [Closure](../../../../../groovy/lang/closure "Closure")<T> closure)`Creates a new BufferedWriter for this file, passes it to the closure, and ensures the stream is flushed and closed after the closure returns. \| \| `<T>` \| `public static T` \| `[withWriter](#withWriter(java.nio.file.Path,%20java.lang.String,%20boolean,%20Closure))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset, boolean writeBom, [Closure](../../../../../groovy/lang/closure "Closure")<T> closure)`Creates a new BufferedWriter for this file, passes it to the closure, and ensures the stream is flushed and closed after the closure returns. \| \| `<T>` \| `public static T` \| `[withWriterAppend](#withWriterAppend(java.nio.file.Path,%20java.lang.String,%20Closure))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset, [Closure](../../../../../groovy/lang/closure "Closure")<T> closure)`Create a new BufferedWriter which will append to this file. \| \| `<T>` \| `public static T` \| `[withWriterAppend](#withWriterAppend(java.nio.file.Path,%20java.lang.String,%20boolean,%20Closure))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset, boolean writeBom, [Closure](../../../../../groovy/lang/closure "Closure")<T> closure)`Create a new BufferedWriter which will append to this file. \| \| `<T>` \| `public static T` \| `[withWriterAppend](#withWriterAppend(java.nio.file.Path,%20Closure))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [Closure](../../../../../groovy/lang/closure "Closure")<T> closure)`Create a new BufferedWriter for this file in append mode. \| \| \| `public static void` \| `[write](#write(java.nio.file.Path,%20java.lang.String))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text)`Write the text to the Path without writing a BOM . \| \| \| `public static void` \| `[write](#write(java.nio.file.Path,%20java.lang.String,%20boolean))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text, boolean writeBom)`Write the text to the Path. \| \| \| `public static void` \| `[write](#write(java.nio.file.Path,%20java.lang.String,%20java.lang.String))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset)`Write the text to the Path without writing a BOM, using the specified encoding. \| \| \| `public static void` \| `[write](#write(java.nio.file.Path,%20java.lang.String,%20java.lang.String,%20boolean))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset, boolean writeBom)`Write the text to the Path, using the specified encoding. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [DefaultGroovyMethodsSupport](../../../../codehaus/groovy/runtime/defaultgroovymethodssupport)` \| `[cloneSimilarCollection](../../../../codehaus/groovy/runtime/defaultgroovymethodssupport#cloneSimilarCollection(Collection,%20int)), [cloneSimilarMap](../../../../codehaus/groovy/runtime/defaultgroovymethodssupport#cloneSimilarMap(Map)), [closeQuietly](../../../../codehaus/groovy/runtime/defaultgroovymethodssupport#closeQuietly(java.io.Closeable)), [closeWithWarning](../../../../codehaus/groovy/runtime/defaultgroovymethodssupport#closeWithWarning(java.io.Closeable)), [createSimilarArray](../../../../codehaus/groovy/runtime/defaultgroovymethodssupport#createSimilarArray(T,%20int)), [createSimilarCollection](../../../../codehaus/groovy/runtime/defaultgroovymethodssupport#createSimilarCollection(Iterable)), [createSimilarCollection](../../../../codehaus/groovy/runtime/defaultgroovymethodssupport#createSimilarCollection(Collection)), [createSimilarCollection](../../../../codehaus/groovy/runtime/defaultgroovymethodssupport#createSimilarCollection(Collection,%20int)), [createSimilarList](../../../../codehaus/groovy/runtime/defaultgroovymethodssupport#createSimilarList(List,%20int)), [createSimilarMap](../../../../codehaus/groovy/runtime/defaultgroovymethodssupport#createSimilarMap(Map)), [createSimilarOrDefaultCollection](../../../../codehaus/groovy/runtime/defaultgroovymethodssupport#createSimilarOrDefaultCollection(java.lang.Object)), [createSimilarQueue](../../../../codehaus/groovy/runtime/defaultgroovymethodssupport#createSimilarQueue(Queue)), [createSimilarSet](../../../../codehaus/groovy/runtime/defaultgroovymethodssupport#createSimilarSet(Set)), [normaliseIndex](../../../../codehaus/groovy/runtime/defaultgroovymethodssupport#normaliseIndex(int,%20int)), [sameType](../../../../codehaus/groovy/runtime/defaultgroovymethodssupport#sameType(java.util.Collection)), [subListBorders](../../../../codehaus/groovy/runtime/defaultgroovymethodssupport#subListBorders(int,%20groovy.lang.Range)), [subListBorders](../../../../codehaus/groovy/runtime/defaultgroovymethodssupport#subListBorders(int,%20groovy.lang.EmptyRange)), [subListRange](../../../../codehaus/groovy/runtime/defaultgroovymethodssupport#subListRange(org.codehaus.groovy.runtime.RangeInfo,%20groovy.lang.IntRange)), [writeUTF16BomIfRequired](../../../../codehaus/groovy/runtime/defaultgroovymethodssupport#writeUTF16BomIfRequired(java.io.Writer,%20java.lang.String)), [writeUTF16BomIfRequired](../../../../codehaus/groovy/runtime/defaultgroovymethodssupport#writeUTF16BomIfRequired(java.io.Writer,%20java.nio.charset.Charset)), [writeUTF16BomIfRequired](../../../../codehaus/groovy/runtime/defaultgroovymethodssupport#writeUTF16BomIfRequired(java.io.OutputStream,%20java.lang.String)), [writeUTF16BomIfRequired](../../../../codehaus/groovy/runtime/defaultgroovymethodssupport#writeUTF16BomIfRequired(java.io.OutputStream,%20java.nio.charset.Charset))` \| Method Detail ------------- ### public static void append([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") text) Append the text at the end of the Path without writing a BOM. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path `text` - the text to append at the end of the Path Since: 2.3.0 ### public static void append([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") file, [Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") reader) Append the text supplied by the Writer at the end of the File without writing a BOM. throws: IOException if an IOException occurs. Parameters: `file` - a Path `reader` - the Reader supplying the text to append at the end of the File Since: 2.3.0 ### public static void append([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") file, [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") writer) Append the text supplied by the Writer at the end of the File without writing a BOM. throws: IOException if an IOException occurs. Parameters: `file` - a File `writer` - the Writer supplying the text to append at the end of the File Since: 2.3.0 ### public static void append([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, byte[] bytes) Append bytes to the end of a Path. It will not be interpreted as text. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path `bytes` - the byte array to append to the end of the Path Since: 2.3.0 ### public static void append([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [InputStream](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html "InputStream") stream) Append binary data to the file. It will not be interpreted as text. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path `stream` - stream to read data from. Since: 2.3.0 ### public static void append([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") text, boolean writeBom) Append the text at the end of the Path. If the default charset is "UTF-16BE" or "UTF-16LE" (or an equivalent alias) and `writeBom` is `true`, the requisite byte order mark is written to the file before the text. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path `text` - the text to append at the end of the Path `writeBom` - whether to write the BOM Since: 2.5.0 ### public static void append([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") text, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset) Append the text at the end of the Path without writing a BOM, using a specified encoding. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path `text` - the text to append at the end of the Path `charset` - the charset used Since: 2.3.0 ### public static void append([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") text, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset, boolean writeBom) Append the text at the end of the Path, using a specified encoding. If the given charset is "UTF-16BE" or "UTF-16LE" (or an equivalent alias), `writeBom` is `true`, and the file doesn't already exist, the requisite byte order mark is written to the file before the text is appended. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path `text` - the text to append at the end of the Path `charset` - the charset used `writeBom` - whether to write the BOM Since: 2.5.0 ### public static void append([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") file, [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") writer, boolean writeBom) Append the text supplied by the Writer at the end of the File, using a specified encoding. If the given charset is "UTF-16BE" or "UTF-16LE" (or an equivalent alias), `writeBom` is `true`, and the file doesn't already exist, the requisite byte order mark is written to the file before the text is appended. throws: IOException if an IOException occurs. Parameters: `file` - a File `writer` - the Writer supplying the text to append at the end of the File `writeBom` - whether to write the BOM Since: 2.5.0 ### public static void append([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") file, [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") writer, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset) Append the text supplied by the Writer at the end of the File without writing a BOM, using a specified encoding. throws: IOException if an IOException occurs. Parameters: `file` - a File `writer` - the Writer supplying the text to append at the end of the File `charset` - the charset used Since: 2.3.0 ### public static void append([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") file, [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") writer, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset, boolean writeBom) Append the text supplied by the Writer at the end of the File, using a specified encoding. If the given charset is "UTF-16BE" or "UTF-16LE" (or an equivalent alias), `writeBom` is `true`, and the file doesn't already exist, the requisite byte order mark is written to the file before the text is appended. throws: IOException if an IOException occurs. Parameters: `file` - a File `writer` - the Writer supplying the text to append at the end of the File `charset` - the charset used `writeBom` - whether to write the BOM Since: 2.5.0 ### public static void append([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") file, [Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") reader, boolean writeBom) Append the text supplied by the Reader at the end of the File, using a specified encoding. If the given charset is "UTF-16BE" or "UTF-16LE" (or an equivalent alias), `writeBom` is `true`, and the file doesn't already exist, the requisite byte order mark is written to the file before the text is appended. throws: IOException if an IOException occurs. Parameters: `file` - a File `reader` - the Reader supplying the text to append at the end of the File `writeBom` - whether to write the BOM Since: 2.5.0 ### public static void append([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") file, [Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") reader, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset) Append the text supplied by the Reader at the end of the File without writing a BOM, using a specified encoding. throws: IOException if an IOException occurs. Parameters: `file` - a File `reader` - the Reader supplying the text to append at the end of the File `charset` - the charset used Since: 2.3.0 ### public static void append([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") file, [Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") reader, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset, boolean writeBom) Append the text supplied by the Reader at the end of the File, using a specified encoding. If the given charset is "UTF-16BE" or "UTF-16LE" (or an equivalent alias), `writeBom` is `true`, and the file doesn't already exist, the requisite byte order mark is written to the file before the text is appended. throws: IOException if an IOException occurs. Parameters: `file` - a File `reader` - the Reader supplying the text to append at the end of the File `charset` - the charset used `writeBom` - whether to write the BOM Since: 2.5.0 ### <T> @[SuppressWarnings](https://docs.oracle.com/javase/8/docs/api/java/lang/SuppressWarnings.html "SuppressWarnings")("unchecked") public static T asType([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") path, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<T> c) Converts this Path to a [Writable](../../../../../groovy/lang/writable "Writable") or delegates to default [DefaultGroovyMethods.asType](../../../../codehaus/groovy/runtime/defaultgroovymethods#asType(Object,%20Class) "DefaultGroovyMethods.asType"). Parameters: `path` - a Path `c` - the desired class Returns: the converted object Since: 2.3.0 ### public static [Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") asWritable([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self) Converts this Path to a [Writable](../../../../../groovy/lang/writable "Writable"). Parameters: `self` - a Path Returns: a Path which wraps the input file and which implements Writable Since: 2.3.0 ### public static [Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") asWritable([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") encoding) Allows a file to return a Writable implementation that can output itself to a Writer stream. Parameters: `self` - a Path `encoding` - the encoding to be used when reading the file's contents Returns: Path which wraps the input file and which implements Writable Since: 2.3.0 ### public static [Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") createParentDirectories([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [FileAttribute](https://docs.oracle.com/javase/8/docs/api/java/nio/file/attribute/FileAttribute.html "FileAttribute")<?> attrs) Creates, if needed, any parent directories for the file associated with this Path. throws: IOException if the parent directories couldn't be created Parameters: `self` - a Path Returns: itself ### public static boolean deleteDir([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self) Deletes a directory with all contained files and subdirectories. The method returns * true, when deletion was successful * true, when it is called for a non existing directory * false, when it is called for a file which isn't a directory * false, when directory couldn't be deleted Parameters: `self` - a Path Returns: true if the file doesn't exist or deletion was successful Since: 2.3.0 ### public static void eachByte([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, @[ClosureParams](../../../../../groovy/transform/stc/closureparams "ClosureParams")(value = SimpleType.class, options = "byte") [Closure](../../../../../groovy/lang/closure) closure) Traverse through each byte of this Path throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path `closure` - a closure See Also: [IOGroovyMethods.eachByte](../../../../codehaus/groovy/runtime/iogroovymethods#eachByte(java.io.InputStream,%20groovy.lang.Closure) "IOGroovyMethods.eachByte") Since: 2.3.0 ### public static void eachByte([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, int bufferLen, @[ClosureParams](../../../../../groovy/transform/stc/closureparams "ClosureParams")(value = FromString.class, options = "byte[],Integer") [Closure](../../../../../groovy/lang/closure) closure) Traverse through the bytes of this Path, bufferLen bytes at a time. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path `bufferLen` - the length of the buffer to use. `closure` - a 2 parameter closure which is passed the byte[] and a number of bytes successfully read. See Also: [IOGroovyMethods.eachByte](../../../../codehaus/groovy/runtime/iogroovymethods#eachByte(java.io.InputStream,%20int,%20groovy.lang.Closure) "IOGroovyMethods.eachByte") Since: 2.3.0 ### public static void eachDir([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, @[ClosureParams](../../../../../groovy/transform/stc/closureparams "ClosureParams")(value = SimpleType.class, options = "java.nio.file.Path") [Closure](../../../../../groovy/lang/closure) closure) Invokes the closure for each subdirectory in this directory, ignoring regular files. throws: java.io.FileNotFoundException if the given directory does not exist throws: IllegalArgumentException if the provided Path object does not represent a directory Parameters: `self` - a Path (that happens to be a folder/directory) `closure` - a closure (the parameter is the Path for the subdirectory file) See Also: [eachFile(Path, groovy.io.FileType, groovy.lang.Closure)](#eachFile(java.nio.file.Path,%20groovy.io.FileType,%20groovy.lang.Closure)) Since: 2.3.0 ### public static void eachDirMatch([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") nameFilter, @[ClosureParams](../../../../../groovy/transform/stc/closureparams "ClosureParams")(value = SimpleType.class, options = "java.nio.file.Path") [Closure](../../../../../groovy/lang/closure) closure) Invokes the closure for each subdirectory whose name (dir.name) matches the given nameFilter in the given directory - calling the DefaultGroovyMethods#isCase(java.lang.Object, java.lang.Object) method to determine if a match occurs. This method can be used with different kinds of filters like regular expressions, classes, ranges etc. Only subdirectories are matched; regular files are ignored. throws: java.io.FileNotFoundException if the given directory does not exist throws: IllegalArgumentException if the provided Path object does not represent a directory Parameters: `self` - a Path (that happens to be a folder/directory) `nameFilter` - the nameFilter to perform on the name of the directory (using the [DefaultGroovyMethods.isCase](../../../../codehaus/groovy/runtime/defaultgroovymethods#isCase(Object,%20Object) "DefaultGroovyMethods.isCase") method) `closure` - the closure to invoke See Also: [eachFileMatch(Path, groovy.io.FileType, Object, groovy.lang.Closure)](#eachFileMatch(java.nio.file.Path,%20groovy.io.FileType,%20java.lang.Object,%20groovy.lang.Closure)) Since: 2.3.0 ### public static void eachDirRecurse([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, @[ClosureParams](../../../../../groovy/transform/stc/closureparams "ClosureParams")(value = SimpleType.class, options = "java.nio.file.Path") [Closure](../../../../../groovy/lang/closure) closure) Recursively processes each descendant subdirectory in this directory. Processing consists of calling `closure` passing it the current subdirectory and then recursively processing that subdirectory. Regular files are ignored during traversal. throws: java.io.FileNotFoundException if the given directory does not exist throws: IllegalArgumentException if the provided Path object does not represent a directory Parameters: `self` - a Path (that happens to be a folder/directory) `closure` - a closure See Also: [eachFileRecurse(Path, groovy.io.FileType, groovy.lang.Closure)](#eachFileRecurse(java.nio.file.Path,%20groovy.io.FileType,%20groovy.lang.Closure)) Since: 2.3.0 ### public static void eachFile([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [FileType](../../../../../groovy/io/filetype) fileType, @[ClosureParams](../../../../../groovy/transform/stc/closureparams "ClosureParams")(value = SimpleType.class, options = "java.nio.file.Path") [Closure](../../../../../groovy/lang/closure) closure) Invokes the closure for each 'child' file in this 'parent' folder/directory. Both regular files and subfolders/subdirectories can be processed depending on the fileType enum value. throws: java.io.FileNotFoundException if the given directory does not exist throws: IllegalArgumentException if the provided Path object does not represent a directory Parameters: `self` - a Path (that happens to be a folder/directory) `fileType` - if normal files or directories or both should be processed `closure` - the closure to invoke Since: 2.3.0 ### public static void eachFile([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [Closure](../../../../../groovy/lang/closure) closure) Invokes the closure for each 'child' file in this 'parent' folder/directory. Both regular files and subfolders/subdirectories are processed. throws: java.io.FileNotFoundException if the given directory does not exist throws: IllegalArgumentException if the provided Path object does not represent a directory Parameters: `self` - a Path (that happens to be a folder/directory) `closure` - a closure (the parameter is the Path for the 'child' file) See Also: [eachFile(Path, groovy.io.FileType, groovy.lang.Closure)](#eachFile(java.nio.file.Path,%20groovy.io.FileType,%20groovy.lang.Closure)) Since: 2.3.0 ### public static void eachFileMatch([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [FileType](../../../../../groovy/io/filetype) fileType, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") nameFilter, @[ClosureParams](../../../../../groovy/transform/stc/closureparams "ClosureParams")(value = SimpleType.class, options = "java.nio.file.Path") [Closure](../../../../../groovy/lang/closure) closure) Invokes the closure for each file whose name (file.name) matches the given nameFilter in the given directory - calling the [DefaultGroovyMethods.isCase](../../../../codehaus/groovy/runtime/defaultgroovymethods#isCase(Object,%20Object) "DefaultGroovyMethods.isCase") method to determine if a match occurs. This method can be used with different kinds of filters like regular expressions, classes, ranges etc. Both regular files and subdirectories may be candidates for matching depending on the value of fileType. ``` // collect names of files in baseDir matching supplied regex pattern import static groovy.io.FileType.* def names = [] baseDir.eachFileMatch FILES, ~/foo\d\.txt/, { names << it.name } assert names == ['foo1.txt', 'foo2.txt'] // remove all .bak files in baseDir baseDir.eachFileMatch FILES, ~/.\.bak/, { Path bak -> bak.delete() } // print out files > 4K in size from baseDir baseDir.eachFileMatch FILES, { new Path(baseDir, it).size() > 4096 }, { println "$it.name ${it.size()}" } ``` throws: java.io.FileNotFoundException if the given directory does not exist throws: IllegalArgumentException if the provided Path object does not represent a directory Parameters: `self` - a Path (that happens to be a folder/directory) `fileType` - whether normal files or directories or both should be processed `nameFilter` - the filter to perform on the name of the file/directory (using the [DefaultGroovyMethods.isCase](../../../../codehaus/groovy/runtime/defaultgroovymethods#isCase(Object,%20Object) "DefaultGroovyMethods.isCase") method) `closure` - the closure to invoke Since: 2.3.0 ### public static void eachFileMatch([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") nameFilter, @[ClosureParams](../../../../../groovy/transform/stc/closureparams "ClosureParams")(value = SimpleType.class, options = "java.nio.file.Path") [Closure](../../../../../groovy/lang/closure) closure) Invokes the closure for each file whose name (file.name) matches the given nameFilter in the given directory - calling the [DefaultGroovyMethods.isCase](../../../../codehaus/groovy/runtime/defaultgroovymethods#isCase(Object,%20Object) "DefaultGroovyMethods.isCase") method to determine if a match occurs. This method can be used with different kinds of filters like regular expressions, classes, ranges etc. Both regular files and subdirectories are matched. throws: java.io.FileNotFoundException if the given directory does not exist throws: IllegalArgumentException if the provided Path object does not represent a directory Parameters: `self` - a Path (that happens to be a folder/directory) `nameFilter` - the nameFilter to perform on the name of the file (using the [DefaultGroovyMethods.isCase](../../../../codehaus/groovy/runtime/defaultgroovymethods#isCase(Object,%20Object) "DefaultGroovyMethods.isCase") method) `closure` - the closure to invoke See Also: [eachFileMatch(Path, groovy.io.FileType, Object, groovy.lang.Closure)](#eachFileMatch(java.nio.file.Path,%20groovy.io.FileType,%20java.lang.Object,%20groovy.lang.Closure)) Since: 2.3.0 ### public static void eachFileRecurse([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [FileType](../../../../../groovy/io/filetype) fileType, @[ClosureParams](../../../../../groovy/transform/stc/closureparams "ClosureParams")(value = SimpleType.class, options = "java.nio.file.Path") [Closure](../../../../../groovy/lang/closure) closure) Processes each descendant file in this directory and any sub-directories. Processing consists of potentially calling `closure` passing it the current file (which may be a normal file or subdirectory) and then if a subdirectory was encountered, recursively processing the subdirectory. Whether the closure is called is determined by whether the file was a normal file or subdirectory and the value of fileType. throws: java.io.FileNotFoundException if the given directory does not exist throws: IllegalArgumentException if the provided Path object does not represent a directory Parameters: `self` - a Path (that happens to be a folder/directory) `fileType` - if normal files or directories or both should be processed `closure` - the closure to invoke on each file Since: 2.3.0 ### public static void eachFileRecurse([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, @[ClosureParams](../../../../../groovy/transform/stc/closureparams "ClosureParams")(value = SimpleType.class, options = "java.nio.file.Path") [Closure](../../../../../groovy/lang/closure) closure) Processes each descendant file in this directory and any sub-directories. Processing consists of calling `closure` passing it the current file (which may be a normal file or subdirectory) and then if a subdirectory was encountered, recursively processing the subdirectory. throws: java.io.FileNotFoundException if the given directory does not exist throws: IllegalArgumentException if the provided Path object does not represent a directory Parameters: `self` - a Path (that happens to be a folder/directory) `closure` - a Closure See Also: [eachFileRecurse(Path, groovy.io.FileType, groovy.lang.Closure)](#eachFileRecurse(java.nio.file.Path,%20groovy.io.FileType,%20groovy.lang.Closure)) Since: 2.3.0 ### <T> public static T eachLine([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, @[ClosureParams](../../../../../groovy/transform/stc/closureparams "ClosureParams")(value = FromString.class, options = {"String", "String,Integer"}) [Closure](../../../../../groovy/lang/closure "Closure")<T> closure) Iterates through this path line by line. Each line is passed to the given 1 or 2 arg closure. The file is read using a reader which is closed before this method returns. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path `closure` - a closure (arg 1 is line, optional arg 2 is line number starting at line 1) Returns: the last value returned by the closure See Also: [eachLine(Path, int, groovy.lang.Closure)](#eachLine(java.nio.file.Path,%20int,%20groovy.lang.Closure)) Since: 2.3.0 ### <T> public static T eachLine([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset, @[ClosureParams](../../../../../groovy/transform/stc/closureparams "ClosureParams")(value = FromString.class, options = {"String", "String,Integer"}) [Closure](../../../../../groovy/lang/closure "Closure")<T> closure) Iterates through this file line by line. Each line is passed to the given 1 or 2 arg closure. The file is read using a reader which is closed before this method returns. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path `charset` - opens the file with a specified charset `closure` - a closure (arg 1 is line, optional arg 2 is line number starting at line 1) Returns: the last value returned by the closure See Also: [eachLine(Path, String, int, groovy.lang.Closure)](#eachLine(java.nio.file.Path,%20java.lang.String,%20int,%20groovy.lang.Closure)) Since: 2.3.0 ### <T> public static T eachLine([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, int firstLine, @[ClosureParams](../../../../../groovy/transform/stc/closureparams "ClosureParams")(value = FromString.class, options = {"String", "String,Integer"}) [Closure](../../../../../groovy/lang/closure "Closure")<T> closure) Iterates through this file line by line. Each line is passed to the given 1 or 2 arg closure. The file is read using a reader which is closed before this method returns. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path `firstLine` - the line number value used for the first line (default is 1, set to 0 to start counting from 0) `closure` - a closure (arg 1 is line, optional arg 2 is line number) Returns: the last value returned by the closure See Also: [IOGroovyMethods.eachLine](../../../../codehaus/groovy/runtime/iogroovymethods#eachLine(java.io.Reader,%20int,%20groovy.lang.Closure) "IOGroovyMethods.eachLine") Since: 2.3.0 ### <T> public static T eachLine([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset, int firstLine, @[ClosureParams](../../../../../groovy/transform/stc/closureparams "ClosureParams")(value = FromString.class, options = {"String", "String,Integer"}) [Closure](../../../../../groovy/lang/closure "Closure")<T> closure) Iterates through this file line by line. Each line is passed to the given 1 or 2 arg closure. The file is read using a reader which is closed before this method returns. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path `charset` - opens the file with a specified charset `firstLine` - the line number value used for the first line (default is 1, set to 0 to start counting from 0) `closure` - a closure (arg 1 is line, optional arg 2 is line number) Returns: the last value returned by the closure See Also: [IOGroovyMethods.eachLine](../../../../codehaus/groovy/runtime/iogroovymethods#eachLine(java.io.Reader,%20int,%20groovy.lang.Closure) "IOGroovyMethods.eachLine") Since: 2.3.0 ### public static void eachObject([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [Closure](../../../../../groovy/lang/closure) closure) Iterates through the given file object by object. throws: java.io.IOException if an IOException occurs. throws: ClassNotFoundException if the class is not found. Parameters: `self` - a `Path` object `closure` - a closure See Also: [IOGroovyMethods.eachObject](../../../../codehaus/groovy/runtime/iogroovymethods#eachObject(java.io.ObjectInputStream,%20groovy.lang.Closure) "IOGroovyMethods.eachObject") Since: 2.3.0 ### public static [Writable](../../../../../groovy/lang/writable) filterLine([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, @[ClosureParams](../../../../../groovy/transform/stc/closureparams "ClosureParams")(value = SimpleType.class, options = "java.lang.String") [Closure](../../../../../groovy/lang/closure) closure) Filters the lines of a Path and creates a Writable in return to stream the filtered lines. throws: java.io.IOException if `self` is not readable Parameters: `self` - a Path `closure` - a closure which returns a boolean indicating to filter the line or not Returns: a Writable closure See Also: [IOGroovyMethods.filterLine](../../../../codehaus/groovy/runtime/iogroovymethods#filterLine(java.io.Reader,%20groovy.lang.Closure) "IOGroovyMethods.filterLine") Since: 2.3.0 ### public static [Writable](../../../../../groovy/lang/writable) filterLine([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset, @[ClosureParams](../../../../../groovy/transform/stc/closureparams "ClosureParams")(value = SimpleType.class, options = "java.lang.String") [Closure](../../../../../groovy/lang/closure) closure) Filters the lines of a Path and creates a Writable in return to stream the filtered lines. throws: java.io.IOException if an IOException occurs Parameters: `self` - a Path `charset` - opens the file with a specified charset `closure` - a closure which returns a boolean indicating to filter the line or not Returns: a Writable closure See Also: [IOGroovyMethods.filterLine](../../../../codehaus/groovy/runtime/iogroovymethods#filterLine(java.io.Reader,%20groovy.lang.Closure) "IOGroovyMethods.filterLine") Since: 2.3.0 ### public static void filterLine([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") writer, @[ClosureParams](../../../../../groovy/transform/stc/closureparams "ClosureParams")(value = SimpleType.class, options = "java.lang.String") [Closure](../../../../../groovy/lang/closure) closure) Filter the lines from this Path, and write them to the given writer based on the given closure predicate. throws: java.io.IOException if `self` is not readable Parameters: `self` - a Path `writer` - a writer destination to write filtered lines to `closure` - a closure which takes each line as a parameter and returns `true` if the line should be written to this writer. See Also: [IOGroovyMethods.filterLine](../../../../codehaus/groovy/runtime/iogroovymethods#filterLine(java.io.Reader,%20java.io.Writer,%20groovy.lang.Closure) "IOGroovyMethods.filterLine") Since: 2.3.0 ### public static void filterLine([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") writer, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset, @[ClosureParams](../../../../../groovy/transform/stc/closureparams "ClosureParams")(value = SimpleType.class, options = "java.lang.String") [Closure](../../../../../groovy/lang/closure) closure) Filter the lines from this Path, and write them to the given writer based on the given closure predicate. throws: java.io.IOException if an IO error occurs Parameters: `self` - a Path `writer` - a writer destination to write filtered lines to `charset` - opens the file with a specified charset `closure` - a closure which takes each line as a parameter and returns `true` if the line should be written to this writer. See Also: [IOGroovyMethods.filterLine](../../../../codehaus/groovy/runtime/iogroovymethods#filterLine(java.io.Reader,%20java.io.Writer,%20groovy.lang.Closure) "IOGroovyMethods.filterLine") Since: 2.3.0 ### public static byte[] getBytes([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self) Read the content of the Path and returns it as a byte[]. throws: java.io.IOException if an IOException occurs. Parameters: `self` - the file whose content we want to read Returns: a String containing the content of the file Since: 2.3.0 ### public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getText([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset) Read the content of the Path using the specified encoding and return it as a String. throws: java.io.IOException if an IOException occurs. Parameters: `self` - the file whose content we want to read `charset` - the charset used to read the content of the file Returns: a String containing the content of the file Since: 2.3.0 ### public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getText([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self) Read the content of the Path and returns it as a String. throws: java.io.IOException if an IOException occurs. Parameters: `self` - the file whose content we want to read Returns: a String containing the content of the file Since: 2.3.0 ### public static [Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") leftShift([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") text) Write the text to the Path. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path `text` - the text to write to the Path Returns: the original file Since: 2.3.0 ### public static [Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") leftShift([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, byte[] bytes) Write bytes to a Path. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path `bytes` - the byte array to append to the end of the Path Returns: the original file Since: 2.3.0 ### public static [Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") leftShift([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") path, [InputStream](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html "InputStream") data) Append binary data to the file. See [append(Path, java.io.InputStream)](#append(java.nio.file.Path,%20java.io.InputStream)) throws: java.io.IOException if an IOException occurs. Parameters: `path` - a Path `data` - an InputStream of data to write to the file Returns: the file Since: 2.3.0 ### public static [DataInputStream](https://docs.oracle.com/javase/8/docs/api/java/io/DataInputStream.html "DataInputStream") newDataInputStream([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self) Create a data input stream for this file throws: java.io.FileNotFoundException if the file is not found. Parameters: `self` - a Path Returns: a DataInputStream of the file Since: 2.3.0 ### public static [DataOutputStream](https://docs.oracle.com/javase/8/docs/api/java/io/DataOutputStream.html "DataOutputStream") newDataOutputStream([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self) Creates a new data output stream for this file. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a file object Returns: the created DataOutputStream Since: 2.3.0 ### public static [BufferedInputStream](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedInputStream.html "BufferedInputStream") newInputStream([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self) Creates a buffered input stream for this file. throws: java.io.FileNotFoundException if the file is not found. Parameters: `self` - a Path Returns: a BufferedInputStream of the file Since: 2.3.0 ### public static [ObjectInputStream](https://docs.oracle.com/javase/8/docs/api/java/io/ObjectInputStream.html "ObjectInputStream") newObjectInputStream([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self) Create an object input stream for this file. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a `Path` object Returns: an object input stream Since: 2.3.0 ### public static [ObjectInputStream](https://docs.oracle.com/javase/8/docs/api/java/io/ObjectInputStream.html "ObjectInputStream") newObjectInputStream([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html "ClassLoader") classLoader) Create an object input stream for this path using the given class loader. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a `Path` object `classLoader` - the class loader to use when loading the class Returns: an object input stream Since: 2.3.0 ### public static [ObjectOutputStream](https://docs.oracle.com/javase/8/docs/api/java/io/ObjectOutputStream.html "ObjectOutputStream") newObjectOutputStream([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self) Create an object output stream for this path. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a `Path` object Returns: an object output stream Since: 2.3.0 ### public static [BufferedOutputStream](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedOutputStream.html "BufferedOutputStream") newOutputStream([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self) Create a buffered output stream for this file. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a file object Returns: the created OutputStream Since: 2.3.0 ### public static [PrintWriter](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html "PrintWriter") newPrintWriter([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self) Create a new PrintWriter for this file. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path Returns: the created PrintWriter Since: 2.3.0 ### public static [PrintWriter](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html "PrintWriter") newPrintWriter([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset) Create a new PrintWriter for this file, using specified charset. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path `charset` - the charset Returns: a PrintWriter Since: 2.3.0 ### public static [BufferedReader](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedReader.html "BufferedReader") newReader([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self) Create a buffered reader for this file. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path Returns: a BufferedReader Since: 2.3.0 ### public static [BufferedReader](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedReader.html "BufferedReader") newReader([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset) Create a buffered reader for this file, using the specified charset as the encoding. throws: java.io.FileNotFoundException if the Path was not found throws: java.io.UnsupportedEncodingException if the encoding specified is not supported Parameters: `self` - a Path `charset` - the charset for this Path Returns: a BufferedReader Since: 2.3.0 ### public static [BufferedWriter](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedWriter.html "BufferedWriter") newWriter([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self) Create a buffered writer for this file. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path Returns: a BufferedWriter Since: 2.3.0 ### public static [BufferedWriter](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedWriter.html "BufferedWriter") newWriter([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, boolean append) Creates a buffered writer for this file, optionally appending to the existing file content. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path `append` - true if data should be appended to the file Returns: a BufferedWriter Since: 2.3.0 ### public static [BufferedWriter](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedWriter.html "BufferedWriter") newWriter([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset, boolean append) Helper method to create a buffered writer for a file without writing a BOM. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path `charset` - the name of the encoding used to write in this file `append` - true if in append mode Returns: a BufferedWriter Since: 2.3.0 ### public static [BufferedWriter](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedWriter.html "BufferedWriter") newWriter([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset, boolean append, boolean writeBom) Helper method to create a buffered writer for a file. If the given charset is "UTF-16BE" or "UTF-16LE" (or an equivalent alias), the requisite byte order mark is written to the stream before the writer is returned. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path `charset` - the name of the encoding used to write in this file `append` - true if in append mode `writeBom` - whether to write a BOM Returns: a BufferedWriter Since: 2.5.0 ### public static [BufferedWriter](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedWriter.html "BufferedWriter") newWriter([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset) Creates a buffered writer for this file without writing a BOM, writing data using the given encoding. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path `charset` - the name of the encoding used to write in this file Returns: a BufferedWriter Since: 2.3.0 ### public static byte[] readBytes([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self) Reads the content of the file into a byte array. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path Returns: a byte array with the contents of the file. Since: 2.3.0 ### public static [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> readLines([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self) Reads the file into a list of Strings, with one item for each line. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path Returns: a List of lines See Also: [IOGroovyMethods.readLines](../../../../codehaus/groovy/runtime/iogroovymethods#readLines(java.io.Reader) "IOGroovyMethods.readLines") Since: 2.3.0 ### public static [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> readLines([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset) Reads the file into a list of Strings, with one item for each line. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path `charset` - opens the file with a specified charset Returns: a List of lines See Also: [IOGroovyMethods.readLines](../../../../codehaus/groovy/runtime/iogroovymethods#readLines(java.io.Reader) "IOGroovyMethods.readLines") Since: 2.3.0 ### public static boolean renameTo([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") newPathName) Renames a file. Parameters: `self` - a Path `newPathName` - The new pathname for the named file Returns: `true` if and only if the renaming succeeded; `false` otherwise Since: 2.3.0 ### public static boolean renameTo([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [URI](https://docs.oracle.com/javase/8/docs/api/java/net/URI.html "URI") newPathName) Renames a file. Parameters: `self` - a Path `newPathName` - The new target path specified as a URI object Returns: `true` if and only if the renaming succeeded; `false` otherwise Since: 2.3.0 ### public static void setBytes([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, byte[] bytes) Write the bytes from the byte array to the Path. throws: java.io.IOException if an IOException occurs. Parameters: `self` - the file to write to `bytes` - the byte[] to write to the file Since: 2.3.0 ### public static void setText([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text) Synonym for write(text) allowing file.text = 'foo'. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path `text` - the text to write to the Path See Also: [write(Path, String)](#write(java.nio.file.Path,%20java.lang.String)) Since: 2.3.0 ### public static void setText([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset) Synonym for write(text, charset) allowing: ``` myFile.setText('some text', charset) ``` or with some help from `ExpandoMetaClass`, you could do something like: ``` myFile.metaClass.setText = { String s -> delegate.setText(s, 'UTF-8') } myfile.text = 'some text' ``` throws: java.io.IOException if an IOException occurs. Parameters: `self` - A Path `charset` - The charset used when writing to the file `text` - The text to write to the Path See Also: [write(Path, String, String)](#write(java.nio.file.Path,%20java.lang.String,%20java.lang.String)) Since: 2.3.0 ### public static long size([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self) Provide the standard Groovy `size()` method for `Path`. Parameters: `self` - a `Path` object Returns: the file's size (length) Since: 2.3.0 ### <T> public static T splitEachLine([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") regex, @[ClosureParams](../../../../../groovy/transform/stc/closureparams "ClosureParams")(value = FromString.class, options = {"List", "String[]"}, conflictResolutionStrategy = PickFirstResolver.class) [Closure](../../../../../groovy/lang/closure "Closure")<T> closure) Iterates through this file line by line, splitting each line using the given regex separator. For each line, the given closure is called with a single parameter being the list of strings computed by splitting the line around matches of the given regular expression. Finally the resources used for processing the file are closed. throws: java.io.IOException if an IOException occurs. throws: java.util.regex.PatternSyntaxException if the regular expression's syntax is invalid Parameters: `self` - a Path `regex` - the delimiting regular expression `closure` - a closure Returns: the last value returned by the closure See Also: [IOGroovyMethods.splitEachLine](../../../../codehaus/groovy/runtime/iogroovymethods#splitEachLine(java.io.Reader,%20String,%20groovy.lang.Closure) "IOGroovyMethods.splitEachLine") Since: 2.3.0 ### <T> public static T splitEachLine([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [Pattern](https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html "Pattern") pattern, @[ClosureParams](../../../../../groovy/transform/stc/closureparams "ClosureParams")(value = FromString.class, options = {"List", "String[]"}, conflictResolutionStrategy = PickFirstResolver.class) [Closure](../../../../../groovy/lang/closure "Closure")<T> closure) Iterates through this file line by line, splitting each line using the given separator Pattern. For each line, the given closure is called with a single parameter being the list of strings computed by splitting the line around matches of the given regular expression Pattern. Finally the resources used for processing the file are closed. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path `pattern` - the regular expression Pattern for the delimiter `closure` - a closure Returns: the last value returned by the closure See Also: [IOGroovyMethods.splitEachLine](../../../../codehaus/groovy/runtime/iogroovymethods#splitEachLine(java.io.Reader,%20java.util.regex.Pattern,%20groovy.lang.Closure) "IOGroovyMethods.splitEachLine") Since: 2.3.0 ### <T> public static T splitEachLine([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") regex, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset, @[ClosureParams](../../../../../groovy/transform/stc/closureparams "ClosureParams")(value = FromString.class, options = {"List", "String[]"}, conflictResolutionStrategy = PickFirstResolver.class) [Closure](../../../../../groovy/lang/closure "Closure")<T> closure) Iterates through this file line by line, splitting each line using the given regex separator. For each line, the given closure is called with a single parameter being the list of strings computed by splitting the line around matches of the given regular expression. Finally the resources used for processing the file are closed. throws: java.io.IOException if an IOException occurs. throws: java.util.regex.PatternSyntaxException if the regular expression's syntax is invalid Parameters: `self` - a Path `regex` - the delimiting regular expression `charset` - opens the file with a specified charset `closure` - a closure Returns: the last value returned by the closure See Also: [IOGroovyMethods.splitEachLine](../../../../codehaus/groovy/runtime/iogroovymethods#splitEachLine(java.io.Reader,%20String,%20groovy.lang.Closure) "IOGroovyMethods.splitEachLine") Since: 2.3.0 ### <T> public static T splitEachLine([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [Pattern](https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html "Pattern") pattern, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset, @[ClosureParams](../../../../../groovy/transform/stc/closureparams "ClosureParams")(value = FromString.class, options = {"List", "String[]"}, conflictResolutionStrategy = PickFirstResolver.class) [Closure](../../../../../groovy/lang/closure "Closure")<T> closure) Iterates through this file line by line, splitting each line using the given regex separator Pattern. For each line, the given closure is called with a single parameter being the list of strings computed by splitting the line around matches of the given regular expression. Finally the resources used for processing the file are closed. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path `pattern` - the regular expression Pattern for the delimiter `charset` - opens the file with a specified charset `closure` - a closure Returns: the last value returned by the closure See Also: [IOGroovyMethods.splitEachLine](../../../../codehaus/groovy/runtime/iogroovymethods#splitEachLine(java.io.Reader,%20java.util.regex.Pattern,%20groovy.lang.Closure) "IOGroovyMethods.splitEachLine") Since: 2.3.0 ### public static void traverse([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, @[NamedParam](../../../../../groovy/transform/namedparam "NamedParam")(value = "type", type = FileType.class) @[NamedParam](../../../../../groovy/transform/namedparam "NamedParam")(value = "preDir", type = Closure.class) @[NamedParam](../../../../../groovy/transform/namedparam "NamedParam")(value = "preRoot", type = Boolean.class) @[NamedParam](../../../../../groovy/transform/namedparam "NamedParam")(value = "postDir", type = Closure.class) @[NamedParam](../../../../../groovy/transform/namedparam "NamedParam")(value = "postRoot", type = Boolean.class) @[NamedParam](../../../../../groovy/transform/namedparam "NamedParam")(value = "visitRoot", type = Boolean.class) @[NamedParam](../../../../../groovy/transform/namedparam "NamedParam")(value = "maxDepth", type = Integer.class) @[NamedParam](../../../../../groovy/transform/namedparam "NamedParam")(value = "filter") @[NamedParam](../../../../../groovy/transform/namedparam "NamedParam")(value = "nameFilter") @[NamedParam](../../../../../groovy/transform/namedparam "NamedParam")(value = "excludeFilter") @[NamedParam](../../../../../groovy/transform/namedparam "NamedParam")(value = "excludeNameFilter") @[NamedParam](../../../../../groovy/transform/namedparam "NamedParam")(value = "sort", type = Closure.class) [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")> options, @[ClosureParams](../../../../../groovy/transform/stc/closureparams "ClosureParams")(value = SimpleType.class, options = "java.nio.file.Path") [Closure](../../../../../groovy/lang/closure) closure) Processes each descendant file in this directory and any sub-directories. Processing consists of potentially calling `closure` passing it the current file (which may be a normal file or subdirectory) and then if a subdirectory was encountered, recursively processing the subdirectory. The traversal can be adapted by providing various options in the `options` Map according to the following keys: type A [FileType](../../../../../groovy/io/filetype "FileType") enum to determine if normal files or directories or both are processed preDir A [Closure](../../../../../groovy/lang/closure "Closure") run before each directory is processed and optionally returning a [FileVisitResult](../../../../../groovy/io/filevisitresult "FileVisitResult") value which can be used to control subsequent processing. preRoot A boolean indicating that the 'preDir' closure should be applied at the root level postDir A [Closure](../../../../../groovy/lang/closure "Closure") run after each directory is processed and optionally returning a [FileVisitResult](../../../../../groovy/io/filevisitresult "FileVisitResult") value which can be used to control subsequent processing. postRoot A boolean indicating that the 'postDir' closure should be applied at the root level visitRoot A boolean indicating that the given closure should be applied for the root dir (not applicable if the 'type' is set to [FileType.FILES](../../../../../groovy/io/filetype#FILES "FileType.FILES")) maxDepth The maximum number of directory levels when recursing (default is -1 which means infinite, set to 0 for no recursion) filter A filter to perform on traversed files/directories (using the [DefaultGroovyMethods.isCase](../../../../codehaus/groovy/runtime/defaultgroovymethods#isCase(java.lang.Object,%20java.lang.Object) "DefaultGroovyMethods.isCase") method). If set, only files/dirs which match are candidates for visiting. nameFilter A filter to perform on the name of traversed files/directories (using the [DefaultGroovyMethods.isCase](../../../../codehaus/groovy/runtime/defaultgroovymethods#isCase(java.lang.Object,%20java.lang.Object) "DefaultGroovyMethods.isCase") method). If set, only files/dirs which match are candidates for visiting. (Must not be set if 'filter' is set) excludeFilter A filter to perform on traversed files/directories (using the [DefaultGroovyMethods.isCase](../../../../codehaus/groovy/runtime/defaultgroovymethods#isCase(java.lang.Object,%20java.lang.Object) "DefaultGroovyMethods.isCase") method). If set, any candidates which match won't be visited. excludeNameFilter A filter to perform on the names of traversed files/directories (using the [DefaultGroovyMethods.isCase](../../../../codehaus/groovy/runtime/defaultgroovymethods#isCase(java.lang.Object,%20java.lang.Object) "DefaultGroovyMethods.isCase") method). If set, any candidates which match won't be visited. (Must not be set if 'excludeFilter' is set) sort A [Closure](../../../../../groovy/lang/closure "Closure") which if set causes the files and subdirectories for each directory to be processed in sorted order. Note that even when processing only files, the order of visited subdirectories will be affected by this parameter. This example prints out file counts and size aggregates for groovy source files within a directory tree: ``` def totalSize = 0 def count = 0 def sortByTypeThenName = { a, b -> a.isFile() != b.isFile() ? a.isFile() <=> b.isFile() : a.name <=> b.name } rootDir.traverse( type : FILES, nameFilter : ~/.\.groovy/, preDir : { if (it.name == '.svn') return SKIP_SUBTREE }, postDir : { println "Found $count files in $it.name totalling $totalSize bytes" totalSize = 0; count = 0 }, postRoot : true sort : sortByTypeThenName ) {it -> totalSize += it.size(); count++ } ``` throws:* java.io.FileNotFoundException if the given directory does not exist throws: IllegalArgumentException if the provided Path object does not represent a directory or illegal filter combinations are supplied Parameters: `self` - a Path (that happens to be a folder/directory) `options` - a Map of options to alter the traversal behavior `closure` - the Closure to invoke on each file/directory and optionally returning a [FileVisitResult](../../../../../groovy/io/filevisitresult "FileVisitResult") value which can be used to control subsequent processing See Also: DefaultGroovyMethods#sort(java.lang.Iterable, groovy.lang.Closure) [FileVisitResult](../../../../../groovy/io/filevisitresult "FileVisitResult") [FileType](../../../../../groovy/io/filetype "FileType") Since: 2.3.0 ### public static void traverse([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, @[ClosureParams](../../../../../groovy/transform/stc/closureparams "ClosureParams")(value = SimpleType.class, options = "java.nio.file.Path") [Closure](../../../../../groovy/lang/closure) closure) Processes each descendant file in this directory and any sub-directories. Convenience method for [traverse(Path, java.util.Map, groovy.lang.Closure)](#traverse(java.nio.file.Path,%20java.util.Map,%20groovy.lang.Closure)) when no options to alter the traversal behavior are required. throws: java.io.FileNotFoundException if the given directory does not exist throws: IllegalArgumentException if the provided Path object does not represent a directory Parameters: `self` - a Path (that happens to be a folder/directory) `closure` - the Closure to invoke on each file/directory and optionally returning a [FileVisitResult](../../../../../groovy/io/filevisitresult "FileVisitResult") value which can be used to control subsequent processing See Also: [traverse(Path, java.util.Map, groovy.lang.Closure)](#traverse(java.nio.file.Path,%20java.util.Map,%20groovy.lang.Closure)) Since: 2.3.0 ### public static void traverse([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, @[NamedParam](../../../../../groovy/transform/namedparam "NamedParam")(value = "type", type = FileType.class) @[NamedParam](../../../../../groovy/transform/namedparam "NamedParam")(value = "preDir", type = Closure.class) @[NamedParam](../../../../../groovy/transform/namedparam "NamedParam")(value = "preRoot", type = Boolean.class) @[NamedParam](../../../../../groovy/transform/namedparam "NamedParam")(value = "postDir", type = Closure.class) @[NamedParam](../../../../../groovy/transform/namedparam "NamedParam")(value = "postRoot", type = Boolean.class) @[NamedParam](../../../../../groovy/transform/namedparam "NamedParam")(value = "visitRoot", type = Boolean.class) @[NamedParam](../../../../../groovy/transform/namedparam "NamedParam")(value = "maxDepth", type = Integer.class) @[NamedParam](../../../../../groovy/transform/namedparam "NamedParam")(value = "filter") @[NamedParam](../../../../../groovy/transform/namedparam "NamedParam")(value = "nameFilter") @[NamedParam](../../../../../groovy/transform/namedparam "NamedParam")(value = "excludeFilter") @[NamedParam](../../../../../groovy/transform/namedparam "NamedParam")(value = "excludeNameFilter") @[NamedParam](../../../../../groovy/transform/namedparam "NamedParam")(value = "sort", type = Closure.class) [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")> options) Invokes the closure specified with key 'visit' in the options Map for each descendant file in this directory tree. Convenience method for [traverse(Path, java.util.Map, groovy.lang.Closure)](#traverse(java.nio.file.Path,%20java.util.Map,%20groovy.lang.Closure)) allowing the 'visit' closure to be included in the options Map rather than as a parameter. throws: java.io.FileNotFoundException if the given directory does not exist throws: IllegalArgumentException if the provided Path object does not represent a directory or illegal filter combinations are supplied Parameters: `self` - a Path (that happens to be a folder/directory) `options` - a Map of options to alter the traversal behavior See Also: [traverse(Path, java.util.Map, groovy.lang.Closure)](#traverse(java.nio.file.Path,%20java.util.Map,%20groovy.lang.Closure)) Since: 2.3.0 ### <T> @[Deprecated](https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html "Deprecated") public static T withCloseable([Closeable](https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html "Closeable") self, @[ClosureParams](../../../../../groovy/transform/stc/closureparams "ClosureParams")(value = SimpleType.class, options = "java.io.Closeable") [Closure](../../../../../groovy/lang/closure "Closure")<T> action) #deprecated use the variant in IOGroovyMethods See Also: [IOGroovyMethods.withCloseable](../../../../codehaus/groovy/runtime/iogroovymethods#withCloseable(java.io.Closeable,%20groovy.lang.Closure) "IOGroovyMethods.withCloseable") Since: 2.3.0 ### <T> public static T withDataInputStream([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, @[ClosureParams](../../../../../groovy/transform/stc/closureparams "ClosureParams")(value = SimpleType.class, options = "java.io.DataInputStream") [Closure](../../../../../groovy/lang/closure "Closure")<T> closure) Create a new DataInputStream for this file and passes it into the closure. This method ensures the stream is closed after the closure returns. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path `closure` - a closure Returns: the value returned by the closure See Also: [IOGroovyMethods.withStream](../../../../codehaus/groovy/runtime/iogroovymethods#withStream(java.io.InputStream,%20groovy.lang.Closure) "IOGroovyMethods.withStream") Since: 2.3.0 ### <T> public static T withDataOutputStream([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, @[ClosureParams](../../../../../groovy/transform/stc/closureparams "ClosureParams")(value = SimpleType.class, options = "java.io.DataOutputStream") [Closure](../../../../../groovy/lang/closure "Closure")<T> closure) Create a new DataOutputStream for this file and passes it into the closure. This method ensures the stream is closed after the closure returns. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path `closure` - a closure Returns: the value returned by the closure See Also: [IOGroovyMethods.withStream](../../../../codehaus/groovy/runtime/iogroovymethods#withStream(java.io.OutputStream,%20groovy.lang.Closure) "IOGroovyMethods.withStream") Since: 2.3.0 ### <T> @[SuppressWarnings](https://docs.oracle.com/javase/8/docs/api/java/lang/SuppressWarnings.html "SuppressWarnings")("unchecked") public static T withInputStream([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, @[ClosureParams](../../../../../groovy/transform/stc/closureparams "ClosureParams")(value = SimpleType.class, options = "java.io.InputStream") [Closure](../../../../../groovy/lang/closure "Closure")<T> closure) Create a new InputStream for this file and passes it into the closure. This method ensures the stream is closed after the closure returns. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path `closure` - a closure Returns: the value returned by the closure See Also: [IOGroovyMethods.withStream](../../../../codehaus/groovy/runtime/iogroovymethods#withStream(java.io.InputStream,%20groovy.lang.Closure) "IOGroovyMethods.withStream") Since: 2.3.0 ### <T> public static T withObjectInputStream([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") path, @[ClosureParams](../../../../../groovy/transform/stc/closureparams "ClosureParams")(value = SimpleType.class, options = "java.io.ObjectInputStream") [Closure](../../../../../groovy/lang/closure "Closure")<T> closure) Create a new ObjectInputStream for this file and pass it to the closure. This method ensures the stream is closed after the closure returns. throws: java.io.IOException if an IOException occurs. Parameters: `path` - a Path `closure` - a closure Returns: the value returned by the closure See Also: [IOGroovyMethods.withStream](../../../../codehaus/groovy/runtime/iogroovymethods#withStream(java.io.InputStream,%20groovy.lang.Closure) "IOGroovyMethods.withStream") Since: 2.3.0 ### <T> public static T withObjectInputStream([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html "ClassLoader") classLoader, @[ClosureParams](../../../../../groovy/transform/stc/closureparams "ClosureParams")(value = SimpleType.class, options = "java.io.ObjectInputStream") [Closure](../../../../../groovy/lang/closure "Closure")<T> closure) Create a new ObjectInputStream for this file associated with the given class loader and pass it to the closure. This method ensures the stream is closed after the closure returns. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path `classLoader` - the class loader to use when loading the class `closure` - a closure Returns: the value returned by the closure See Also: [IOGroovyMethods.withStream](../../../../codehaus/groovy/runtime/iogroovymethods#withStream(java.io.InputStream,%20groovy.lang.Closure) "IOGroovyMethods.withStream") Since: 2.3.0 ### <T> public static T withObjectOutputStream([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, @[ClosureParams](../../../../../groovy/transform/stc/closureparams "ClosureParams")(value = SimpleType.class, options = "java.io.ObjectOutputStream") [Closure](../../../../../groovy/lang/closure "Closure")<T> closure) Create a new ObjectOutputStream for this path and then pass it to the closure. This method ensures the stream is closed after the closure returns. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path `closure` - a closure Returns: the value returned by the closure See Also: IOGroovyMethods#withStream(java.io.OutputStream, groovy.lang.Closure) Since: 2.3.0 ### <T> @[SuppressWarnings](https://docs.oracle.com/javase/8/docs/api/java/lang/SuppressWarnings.html "SuppressWarnings")("unchecked") public static T withOutputStream([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, @[ClosureParams](../../../../../groovy/transform/stc/closureparams "ClosureParams")(value = SimpleType.class, options = "java.io.OutputStream") [Closure](../../../../../groovy/lang/closure "Closure")<T> closure) Creates a new OutputStream for this file and passes it into the closure. This method ensures the stream is closed after the closure returns. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path `closure` - a closure Returns: the value returned by the closure See Also: [IOGroovyMethods.withStream](../../../../codehaus/groovy/runtime/iogroovymethods#withStream(java.io.OutputStream,%20groovy.lang.Closure) "IOGroovyMethods.withStream") Since: 2.3.0 ### <T> public static T withPrintWriter([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, @[ClosureParams](../../../../../groovy/transform/stc/closureparams "ClosureParams")(value = SimpleType.class, options = "java.io.PrintWriter") [Closure](../../../../../groovy/lang/closure "Closure")<T> closure) Create a new PrintWriter for this file which is then passed it into the given closure. This method ensures its the writer is closed after the closure returns. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path `closure` - the closure to invoke with the PrintWriter Returns: the value returned by the closure Since: 2.3.0 ### <T> public static T withPrintWriter([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset, @[ClosureParams](../../../../../groovy/transform/stc/closureparams "ClosureParams")(value = SimpleType.class, options = "java.io.PrintWriter") [Closure](../../../../../groovy/lang/closure "Closure")<T> closure) Create a new PrintWriter with a specified charset for this file. The writer is passed to the closure, and will be closed before this method returns. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path `charset` - the charset `closure` - the closure to invoke with the PrintWriter Returns: the value returned by the closure Since: 2.3.0 ### <T> public static T withReader([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, @[ClosureParams](../../../../../groovy/transform/stc/closureparams "ClosureParams")(value = SimpleType.class, options = "java.io.Reader") [Closure](../../../../../groovy/lang/closure "Closure")<T> closure) Create a new BufferedReader for this file and then passes it into the closure, ensuring the reader is closed after the closure returns. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a file object `closure` - a closure Returns: the value returned by the closure Since: 2.3.0 ### <T> public static T withReader([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset, @[ClosureParams](../../../../../groovy/transform/stc/closureparams "ClosureParams")(value = SimpleType.class, options = "java.io.Reader") [Closure](../../../../../groovy/lang/closure "Closure")<T> closure) Create a new BufferedReader for this file using the specified charset and then passes it into the closure, ensuring the reader is closed after the closure returns. The writer will use the given charset encoding, but will not write a BOM. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a file object `charset` - the charset for this input stream `closure` - a closure Returns: the value returned by the closure Since: 2.3.0 ### <T> public static T withWriter([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, @[ClosureParams](../../../../../groovy/transform/stc/closureparams "ClosureParams")(value = SimpleType.class, options = "java.io.BufferedWriter") [Closure](../../../../../groovy/lang/closure "Closure")<T> closure) Creates a new BufferedWriter for this file, passes it to the closure, and ensures the stream is flushed and closed after the closure returns. The writer will not write a BOM. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path `closure` - a closure Returns: the value returned by the closure Since: 2.3.0 ### <T> public static T withWriter([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset, @[ClosureParams](../../../../../groovy/transform/stc/closureparams "ClosureParams")(value = SimpleType.class, options = "java.io.BufferedWriter") [Closure](../../../../../groovy/lang/closure "Closure")<T> closure) Creates a new BufferedWriter for this file, passes it to the closure, and ensures the stream is flushed and closed after the closure returns. The writer will use the given charset encoding, but will not write a BOM. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path `charset` - the charset used `closure` - a closure Returns: the value returned by the closure Since: 2.3.0 ### <T> public static T withWriter([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset, boolean writeBom, @[ClosureParams](../../../../../groovy/transform/stc/closureparams "ClosureParams")(value = SimpleType.class, options = "java.io.BufferedWriter") [Closure](../../../../../groovy/lang/closure "Closure")<T> closure) Creates a new BufferedWriter for this file, passes it to the closure, and ensures the stream is flushed and closed after the closure returns. The writer will use the given charset encoding. If the given charset is "UTF-16BE" or "UTF-16LE" (or an equivalent alias), `writeBom` is `true`, and the file doesn't already exist, the requisite byte order mark is written to the stream when the writer is created. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path `charset` - the charset used `writeBom` - whether to write the BOM `closure` - a closure Returns: the value returned by the closure Since: 2.5.0 ### <T> public static T withWriterAppend([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset, @[ClosureParams](../../../../../groovy/transform/stc/closureparams "ClosureParams")(value = SimpleType.class, options = "java.io.BufferedWriter") [Closure](../../../../../groovy/lang/closure "Closure")<T> closure) Create a new BufferedWriter which will append to this file. The writer is passed to the closure and will be closed before this method returns. The writer will use the given charset encoding, but will not write a BOM. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path `charset` - the charset used `closure` - a closure Returns: the value returned by the closure Since: 2.3.0 ### <T> public static T withWriterAppend([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset, boolean writeBom, @[ClosureParams](../../../../../groovy/transform/stc/closureparams "ClosureParams")(value = SimpleType.class, options = "java.io.BufferedWriter") [Closure](../../../../../groovy/lang/closure "Closure")<T> closure) Create a new BufferedWriter which will append to this file. The writer is passed to the closure and will be closed before this method returns. The writer will use the given charset encoding. If the given charset is "UTF-16BE" or "UTF-16LE" (or an equivalent alias), `writeBom` is `true`, and the file doesn't already exist, the requisite byte order mark is written to the stream when the writer is created. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path `charset` - the charset used `writeBom` - whether to write the BOM `closure` - a closure Returns: the value returned by the closure Since: 2.5.0 ### <T> public static T withWriterAppend([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, @[ClosureParams](../../../../../groovy/transform/stc/closureparams "ClosureParams")(value = SimpleType.class, options = "java.io.BufferedWriter") [Closure](../../../../../groovy/lang/closure "Closure")<T> closure) Create a new BufferedWriter for this file in append mode. The writer is passed to the closure and is closed after the closure returns. The writer will not write a BOM. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path `closure` - a closure Returns: the value returned by the closure Since: 2.3.0 ### public static void write([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text) Write the text to the Path without writing a BOM . throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path `text` - the text to write to the Path Since: 2.3.0 ### public static void write([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text, boolean writeBom) Write the text to the Path. If the default charset is "UTF-16BE" or "UTF-16LE" (or an equivalent alias) and `writeBom` is `true`, the requisite byte order mark is written to the file before the text. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path `text` - the text to write to the Path `writeBom` - whether to write the BOM Since: 2.5.0 ### public static void write([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset) Write the text to the Path without writing a BOM, using the specified encoding. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path `text` - the text to write to the Path `charset` - the charset used Since: 2.3.0 ### public static void write([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") charset, boolean writeBom) Write the text to the Path, using the specified encoding. If the given charset is "UTF-16BE" or "UTF-16LE" (or an equivalent alias) and `writeBom` is `true`, the requisite byte order mark is written to the file before the text. throws: java.io.IOException if an IOException occurs. Parameters: `self` - a Path `text` - the text to write to the Path `charset` - the charset used `writeBom` - whether to write a BOM Since: 2.5.0	programming_docs
groovy [Java] Class YamlConverter [Java] Class YamlConverter ========================== * org.apache.groovy.yaml.util.YamlConverter ``` public final class YamlConverter extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` A converter for converting YAML to JSON, vice versa Since: 3.0.0 Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[convertJsonToYaml](#convertJsonToYaml(java.io.Reader))([Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") jsonReader)`Convert json to yaml \| \| \| `public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[convertYamlToJson](#convertYamlToJson(java.io.Reader))([Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") yamlReader)`Convert yaml to json \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") convertJsonToYaml([Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") jsonReader) Convert json to yaml Parameters: `jsonReader` - the reader of json Returns: the text of yaml ### public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") convertYamlToJson([Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") yamlReader) Convert yaml to json Parameters: `yamlReader` - the reader of yaml Returns: the text of json groovy [Java] Class MetaClass<T> [Java] Class MetaClass<T> ========================= * org.apache.groovy.metaclass.MetaClass ``` @[Incubating](../lang/annotation/incubating "Incubating") public final class MetaClass<T> extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` A MetaClass within Groovy defines the behaviour of any given Groovy or Java class Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [MetaMethod](../../../../groovy/lang/metamethod)` \| `[getMethod](#getMethod(java.lang.String,%20java.lang.Class))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")[] parameters)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### public [MetaMethod](../../../../groovy/lang/metamethod) getMethod([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")[] parameters) groovy [Java] Class Realm [Java] Class Realm ================== * org.apache.groovy.metaclass.Realm ``` @[Incubating](../lang/annotation/incubating "Incubating") public final class Realm extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` A Realm is the representation of a metaclass layer in a tree of realm objects. Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `protected [MetaClassConstant](../internal/metaclass/metaclassconstant "MetaClassConstant")<?>` \| `[computeValue](#computeValue(Class))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<?> type)` \| \| `<T>` \| `public [MetaClass](metaclass "MetaClass")<T>` \| `[getMetaClass](#getMetaClass(Class))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<T> theClass)` \| \| \| `public static [Realm](realm)` \| `[newRealm](#newRealm(java.lang.String,%20org.apache.groovy.metaclass.Realm))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Realm](realm) parent)` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[toString](#toString())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") @[SuppressWarnings](https://docs.oracle.com/javase/8/docs/api/java/lang/SuppressWarnings.html "SuppressWarnings")("unchecked") protected [MetaClassConstant](../internal/metaclass/metaclassconstant "MetaClassConstant")<?> computeValue([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<?> type) ### <T> public [MetaClass](metaclass "MetaClass")<T> getMetaClass([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<T> theClass) ### public static [Realm](realm) newRealm([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Realm](realm) parent) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") toString() groovy [Groovy] Class DocGenerator [Groovy] Class DocGenerator =========================== * org.apache.groovy.docgenerator.DocGenerator ``` class DocGenerator extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Generate documentation about the methods provided by the Groovy Development Kit that enhance the standard JDK classes. Properties Summary ------------------ Properties \| Type \| Name and description \| \| `[DocGenerator.DocSource](docgenerator.docsource)` \| `[docSource](#docSource)` \| \| `[File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File")` \| `[outputDir](#outputDir)` \| \| `[List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File")>` \| `[sourceFiles](#sourceFiles)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[DocGenerator](#DocGenerator(List,%20java.io.File))([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File")> sourceFiles, [File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File") outputFolder)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `void` \| `[generateAll](#generateAll())()`Builds an HTML page from the structure of DefaultGroovyMethods. \| \| \| `static void` \| `[main](#main(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")[] args)`Main entry point. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Property Detail --------------- ### [DocGenerator.DocSource](docgenerator.docsource) docSource ### [File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File") outputDir ### [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File")> sourceFiles Constructor Detail ------------------ ### DocGenerator([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File")> sourceFiles, [File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File") outputFolder) Method Detail ------------- ### void generateAll() Builds an HTML page from the structure of DefaultGroovyMethods. ### static void main([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")[] args) Main entry point. groovy [Groovy] Class GinqGroovyMethods [Groovy] Class GinqGroovyMethods ================================ * org.apache.groovy.ginq.GinqGroovyMethods ``` @[Incubating](../lang/annotation/incubating "Incubating") @[CompileStatic](../../../../groovy/transform/compilestatic "CompileStatic") class GinqGroovyMethods extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Declare GINQ macro methods Since: 4.0.0 Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `static [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>` \| `[CONF\_LIST](#CONF_LIST)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[CONF\_PARALLEL](#CONF_PARALLEL)` \| \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `static [Expression](../../../codehaus/groovy/ast/expr/expression)` \| `[GQ](#GQ(org.codehaus.groovy.macro.runtime.MacroContext,%20org.codehaus.groovy.ast.expr.ClosureExpression))([MacroContext](../../../codehaus/groovy/macro/runtime/macrocontext) ctx, [ClosureExpression](../../../codehaus/groovy/ast/expr/closureexpression) ginqClosureExpression)`Transform GINQ code to target method invocation \| \| \| `static [Expression](../../../codehaus/groovy/ast/expr/expression)` \| `[GQ](#GQ(org.codehaus.groovy.macro.runtime.MacroContext,%20org.codehaus.groovy.ast.expr.MapExpression,%20org.codehaus.groovy.ast.expr.ClosureExpression))([MacroContext](../../../codehaus/groovy/macro/runtime/macrocontext) ctx, [MapExpression](../../../codehaus/groovy/ast/expr/mapexpression) ginqConfigurationMapExpression, [ClosureExpression](../../../codehaus/groovy/ast/expr/closureexpression) ginqClosureExpression)`Transform GINQ code to target method invocation \| \| \| `static [Expression](../../../codehaus/groovy/ast/expr/expression)` \| `[GQL](#GQL(org.codehaus.groovy.macro.runtime.MacroContext,%20org.codehaus.groovy.ast.expr.ClosureExpression))([MacroContext](../../../codehaus/groovy/macro/runtime/macrocontext) ctx, [ClosureExpression](../../../codehaus/groovy/ast/expr/closureexpression) ginqClosureExpression)`Represents the abbreviation of `GQ {...`.toList()}, which is very useful when used as list comprehension \| \| \| `static [Expression](../../../codehaus/groovy/ast/expr/expression)` \| `[GQL](#GQL(org.codehaus.groovy.macro.runtime.MacroContext,%20org.codehaus.groovy.ast.expr.MapExpression,%20org.codehaus.groovy.ast.expr.ClosureExpression))([MacroContext](../../../codehaus/groovy/macro/runtime/macrocontext) ctx, [MapExpression](../../../codehaus/groovy/ast/expr/mapexpression) ginqConfigurationMapExpression, [ClosureExpression](../../../codehaus/groovy/ast/expr/closureexpression) ginqClosureExpression)`Represents the abbreviation of `GQ {...`.toList()}, which is very useful when used as list comprehension \| \| \| `static [Expression](../../../codehaus/groovy/ast/expr/expression)` \| `[transformGinqCode](#transformGinqCode(org.codehaus.groovy.control.SourceUnit,%20org.codehaus.groovy.ast.expr.MapExpression,%20java.sql.Statement))([SourceUnit](../../../codehaus/groovy/control/sourceunit) sourceUnit, [MapExpression](../../../codehaus/groovy/ast/expr/mapexpression) ginqConfigurationMapExpression, [Statement](https://docs.oracle.com/javase/8/docs/api/java/sql/Statement.html "Statement") code)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Field Detail ------------ ### public static final [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> CONF\_LIST ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") CONF\_PARALLEL Method Detail ------------- ### @[Macro](../../../codehaus/groovy/macro/runtime/macro "Macro") static [Expression](../../../codehaus/groovy/ast/expr/expression) GQ([MacroContext](../../../codehaus/groovy/macro/runtime/macrocontext) ctx, [ClosureExpression](../../../codehaus/groovy/ast/expr/closureexpression) ginqClosureExpression) Transform GINQ code to target method invocation Parameters: `ctx` - the macro context `ginqClosureExpression` - hold the GINQ code Returns: target method invocation Since: 4.0.0 ### @[Macro](../../../codehaus/groovy/macro/runtime/macro "Macro") static [Expression](../../../codehaus/groovy/ast/expr/expression) GQ([MacroContext](../../../codehaus/groovy/macro/runtime/macrocontext) ctx, [MapExpression](../../../codehaus/groovy/ast/expr/mapexpression) ginqConfigurationMapExpression, [ClosureExpression](../../../codehaus/groovy/ast/expr/closureexpression) ginqClosureExpression) Transform GINQ code to target method invocation Parameters: `ctx` - the macro context `ginqConfigurationMapExpression` - specify the configuration for GINQ, e.g. `astWalker`, `optimize`, `parallel` `ginqClosureExpression` - hold the GINQ code Returns: target method invocation Since: 4.0.0 ### @[Macro](../../../codehaus/groovy/macro/runtime/macro "Macro") static [Expression](../../../codehaus/groovy/ast/expr/expression) GQL([MacroContext](../../../codehaus/groovy/macro/runtime/macrocontext) ctx, [ClosureExpression](../../../codehaus/groovy/ast/expr/closureexpression) ginqClosureExpression) Represents the abbreviation of `GQ {...`.toList()}, which is very useful when used as list comprehension Parameters: `ctx` - the macro context `ginqClosureExpression` - hold the GINQ code Returns: target method invocation Since: 4.0.0 ### @[Macro](../../../codehaus/groovy/macro/runtime/macro "Macro") static [Expression](../../../codehaus/groovy/ast/expr/expression) GQL([MacroContext](../../../codehaus/groovy/macro/runtime/macrocontext) ctx, [MapExpression](../../../codehaus/groovy/ast/expr/mapexpression) ginqConfigurationMapExpression, [ClosureExpression](../../../codehaus/groovy/ast/expr/closureexpression) ginqClosureExpression) Represents the abbreviation of `GQ {...`.toList()}, which is very useful when used as list comprehension Parameters: `ctx` - the macro context `ginqConfigurationMapExpression` - specify the configuration for GINQ, e.g. `astWalker`, `optimize`, `parallel` `ginqClosureExpression` - hold the GINQ code Returns: target method invocation Since: 4.0.0 ### static [Expression](../../../codehaus/groovy/ast/expr/expression) transformGinqCode([SourceUnit](../../../codehaus/groovy/control/sourceunit) sourceUnit, [MapExpression](../../../codehaus/groovy/ast/expr/mapexpression) ginqConfigurationMapExpression, [Statement](https://docs.oracle.com/javase/8/docs/api/java/sql/Statement.html "Statement") code)	programming_docs
groovy [Java] Class InvalidOptionException [Java] Class InvalidOptionException =================================== * org.apache.groovy.ginq.InvalidOptionException ``` public class InvalidOptionException extends [GroovyException](../../../codehaus/groovy/groovyexception) ``` Represents invalid options, e.g. unsupported options Since: 4.0.0 Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[InvalidOptionException](#InvalidOptionException(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [GroovyException](../../../codehaus/groovy/groovyexception)` \| `[isFatal](../../../codehaus/groovy/groovyexception#isFatal()), [setFatal](../../../codehaus/groovy/groovyexception#setFatal(boolean))` \| Constructor Detail ------------------ ### public InvalidOptionException([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message) groovy [Groovy] Class GinqAstWalker.14 [Groovy] Class GinqAstWalker.14 =============================== * org.apache.groovy.ginq.provider.collection.GinqAstWalker.14 ``` class GinqAstWalker.14 extends [ExpressionTransformer](../../../../../codehaus/groovy/ast/expr/expressiontransformer) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[GinqAstWalker.14](#GinqAstWalker.14())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[transform](#transform(org.codehaus.groovy.ast.expr.Expression))([Expression](../../../../../codehaus/groovy/ast/expr/expression) expr)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `interface [ExpressionTransformer](../../../../../codehaus/groovy/ast/expr/expressiontransformer)` \| `[transform](../../../../../codehaus/groovy/ast/expr/expressiontransformer#transform(org.codehaus.groovy.ast.expr.Expression))` \| Constructor Detail ------------------ ### GinqAstWalker.14() Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") [Expression](../../../../../codehaus/groovy/ast/expr/expression) transform([Expression](../../../../../codehaus/groovy/ast/expr/expression) expr) groovy [Groovy] Class GinqAstWalker.1 [Groovy] Class GinqAstWalker.1 ============================== * org.apache.groovy.ginq.provider.collection.GinqAstWalker.1 ``` class GinqAstWalker.1 extends [GinqAstBaseVisitor](../../dsl/ginqastbasevisitor) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[GinqAstWalker.1](#GinqAstWalker.1())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `void` \| `[visitMethodCallExpression](#visitMethodCallExpression(org.codehaus.groovy.ast.expr.MethodCallExpression))([MethodCallExpression](../../../../../codehaus/groovy/ast/expr/methodcallexpression) call)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [GinqAstBaseVisitor](../../dsl/ginqastbasevisitor)` \| `[visit](../../dsl/ginqastbasevisitor#visit(org.apache.groovy.ginq.dsl.expression.AbstractGinqExpression)), [visitFromExpression](../../dsl/ginqastbasevisitor#visitFromExpression(org.apache.groovy.ginq.dsl.expression.FromExpression)), [visitGinqExpression](../../dsl/ginqastbasevisitor#visitGinqExpression(org.apache.groovy.ginq.dsl.expression.GinqExpression)), [visitGroupExpression](../../dsl/ginqastbasevisitor#visitGroupExpression(org.apache.groovy.ginq.dsl.expression.GroupExpression)), [visitHavingExpression](../../dsl/ginqastbasevisitor#visitHavingExpression(org.apache.groovy.ginq.dsl.expression.HavingExpression)), [visitJoinExpression](../../dsl/ginqastbasevisitor#visitJoinExpression(org.apache.groovy.ginq.dsl.expression.JoinExpression)), [visitLimitExpression](../../dsl/ginqastbasevisitor#visitLimitExpression(org.apache.groovy.ginq.dsl.expression.LimitExpression)), [visitOnExpression](../../dsl/ginqastbasevisitor#visitOnExpression(org.apache.groovy.ginq.dsl.expression.OnExpression)), [visitOrderExpression](../../dsl/ginqastbasevisitor#visitOrderExpression(org.apache.groovy.ginq.dsl.expression.OrderExpression)), [visitSelectExpression](../../dsl/ginqastbasevisitor#visitSelectExpression(org.apache.groovy.ginq.dsl.expression.SelectExpression)), [visitShutdownExpression](../../dsl/ginqastbasevisitor#visitShutdownExpression(org.apache.groovy.ginq.dsl.expression.ShutdownExpression)), [visitWhereExpression](../../dsl/ginqastbasevisitor#visitWhereExpression(org.apache.groovy.ginq.dsl.expression.WhereExpression))` \| \| `class [CodeVisitorSupport](../../../../../codehaus/groovy/ast/codevisitorsupport)` \| `[afterSwitchConditionExpressionVisited](../../../../../codehaus/groovy/ast/codevisitorsupport#afterSwitchConditionExpressionVisited(org.codehaus.groovy.ast.stmt.SwitchStatement)), [visitArgumentlistExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitArgumentlistExpression(org.codehaus.groovy.ast.expr.ArgumentListExpression)), [visitArrayExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitArrayExpression(org.codehaus.groovy.ast.expr.ArrayExpression)), [visitAssertStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitAssertStatement(org.codehaus.groovy.ast.stmt.AssertStatement)), [visitAttributeExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitAttributeExpression(org.codehaus.groovy.ast.expr.AttributeExpression)), [visitBinaryExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBinaryExpression(org.codehaus.groovy.ast.expr.BinaryExpression)), [visitBitwiseNegationExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBitwiseNegationExpression(org.codehaus.groovy.ast.expr.BitwiseNegationExpression)), [visitBlockStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBlockStatement(org.codehaus.groovy.ast.stmt.BlockStatement)), [visitBooleanExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBooleanExpression(org.codehaus.groovy.ast.expr.BooleanExpression)), [visitBreakStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBreakStatement(org.codehaus.groovy.ast.stmt.BreakStatement)), [visitBytecodeExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBytecodeExpression(org.codehaus.groovy.classgen.BytecodeExpression)), [visitCaseStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitCaseStatement(org.codehaus.groovy.ast.stmt.CaseStatement)), [visitCastExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitCastExpression(org.codehaus.groovy.ast.expr.CastExpression)), [visitCatchStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitCatchStatement(org.codehaus.groovy.ast.stmt.CatchStatement)), [visitClassExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitClassExpression(org.codehaus.groovy.ast.expr.ClassExpression)), [visitClosureExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitClosureExpression(org.codehaus.groovy.ast.expr.ClosureExpression)), [visitClosureListExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitClosureListExpression(org.codehaus.groovy.ast.expr.ClosureListExpression)), [visitConstantExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitConstantExpression(org.codehaus.groovy.ast.expr.ConstantExpression)), [visitConstructorCallExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitConstructorCallExpression(org.codehaus.groovy.ast.expr.ConstructorCallExpression)), [visitContinueStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitContinueStatement(org.codehaus.groovy.ast.stmt.ContinueStatement)), [visitDeclarationExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitDeclarationExpression(org.codehaus.groovy.ast.expr.DeclarationExpression)), [visitDoWhileLoop](../../../../../codehaus/groovy/ast/codevisitorsupport#visitDoWhileLoop(org.codehaus.groovy.ast.stmt.DoWhileStatement)), [visitEmptyStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitEmptyStatement(org.codehaus.groovy.ast.stmt.EmptyStatement)), [visitExpressionStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitExpressionStatement(org.codehaus.groovy.ast.stmt.ExpressionStatement)), [visitFieldExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitFieldExpression(org.codehaus.groovy.ast.expr.FieldExpression)), [visitForLoop](../../../../../codehaus/groovy/ast/codevisitorsupport#visitForLoop(org.codehaus.groovy.ast.stmt.ForStatement)), [visitGStringExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitGStringExpression(org.codehaus.groovy.ast.expr.GStringExpression)), [visitIfElse](../../../../../codehaus/groovy/ast/codevisitorsupport#visitIfElse(org.codehaus.groovy.ast.stmt.IfStatement)), [visitLambdaExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitLambdaExpression(org.codehaus.groovy.ast.expr.LambdaExpression)), [visitListExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitListExpression(org.codehaus.groovy.ast.expr.ListExpression)), [visitMapEntryExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitMapEntryExpression(org.codehaus.groovy.ast.expr.MapEntryExpression)), [visitMapExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitMapExpression(org.codehaus.groovy.ast.expr.MapExpression)), [visitMethodCallExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitMethodCallExpression(org.codehaus.groovy.ast.expr.MethodCallExpression)), [visitMethodPointerExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitMethodPointerExpression(org.codehaus.groovy.ast.expr.MethodPointerExpression)), [visitMethodReferenceExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitMethodReferenceExpression(org.codehaus.groovy.ast.expr.MethodReferenceExpression)), [visitNotExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitNotExpression(org.codehaus.groovy.ast.expr.NotExpression)), [visitPostfixExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitPostfixExpression(org.codehaus.groovy.ast.expr.PostfixExpression)), [visitPrefixExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitPrefixExpression(org.codehaus.groovy.ast.expr.PrefixExpression)), [visitPropertyExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitPropertyExpression(org.codehaus.groovy.ast.expr.PropertyExpression)), [visitRangeExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitRangeExpression(org.codehaus.groovy.ast.expr.RangeExpression)), [visitReturnStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitReturnStatement(org.codehaus.groovy.ast.stmt.ReturnStatement)), [visitShortTernaryExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitShortTernaryExpression(org.codehaus.groovy.ast.expr.ElvisOperatorExpression)), [visitSpreadExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitSpreadExpression(org.codehaus.groovy.ast.expr.SpreadExpression)), [visitSpreadMapExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitSpreadMapExpression(org.codehaus.groovy.ast.expr.SpreadMapExpression)), [visitStaticMethodCallExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitStaticMethodCallExpression(org.codehaus.groovy.ast.expr.StaticMethodCallExpression)), [visitSwitch](../../../../../codehaus/groovy/ast/codevisitorsupport#visitSwitch(org.codehaus.groovy.ast.stmt.SwitchStatement)), [visitSynchronizedStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitSynchronizedStatement(org.codehaus.groovy.ast.stmt.SynchronizedStatement)), [visitTernaryExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitTernaryExpression(org.codehaus.groovy.ast.expr.TernaryExpression)), [visitThrowStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitThrowStatement(org.codehaus.groovy.ast.stmt.ThrowStatement)), [visitTryCatchFinally](../../../../../codehaus/groovy/ast/codevisitorsupport#visitTryCatchFinally(org.codehaus.groovy.ast.stmt.TryCatchStatement)), [visitTupleExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitTupleExpression(org.codehaus.groovy.ast.expr.TupleExpression)), [visitUnaryMinusExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitUnaryMinusExpression(org.codehaus.groovy.ast.expr.UnaryMinusExpression)), [visitUnaryPlusExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitUnaryPlusExpression(org.codehaus.groovy.ast.expr.UnaryPlusExpression)), [visitVariableExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitVariableExpression(org.codehaus.groovy.ast.expr.VariableExpression)), [visitWhileLoop](../../../../../codehaus/groovy/ast/codevisitorsupport#visitWhileLoop(org.codehaus.groovy.ast.stmt.WhileStatement))` \| Constructor Detail ------------------ ### GinqAstWalker.1() Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") void visitMethodCallExpression([MethodCallExpression](../../../../../codehaus/groovy/ast/expr/methodcallexpression) call) groovy [Groovy] Class GinqAstWalker.13 [Groovy] Class GinqAstWalker.13 =============================== * org.apache.groovy.ginq.provider.collection.GinqAstWalker.13 ``` class GinqAstWalker.13 extends [ExpressionTransformer](../../../../../codehaus/groovy/ast/expr/expressiontransformer) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[GinqAstWalker.13](#GinqAstWalker.13())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[transform](#transform(org.codehaus.groovy.ast.expr.Expression))([Expression](../../../../../codehaus/groovy/ast/expr/expression) expression)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `interface [ExpressionTransformer](../../../../../codehaus/groovy/ast/expr/expressiontransformer)` \| `[transform](../../../../../codehaus/groovy/ast/expr/expressiontransformer#transform(org.codehaus.groovy.ast.expr.Expression))` \| Constructor Detail ------------------ ### GinqAstWalker.13() Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") [Expression](../../../../../codehaus/groovy/ast/expr/expression) transform([Expression](../../../../../codehaus/groovy/ast/expr/expression) expression) groovy [Groovy] Class GinqAstWalker.6 [Groovy] Class GinqAstWalker.6 ============================== * org.apache.groovy.ginq.provider.collection.GinqAstWalker.6 ``` class GinqAstWalker.6 extends [GinqAstBaseVisitor](../../dsl/ginqastbasevisitor) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[GinqAstWalker.6](#GinqAstWalker.6())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `void` \| `[visitMethodCallExpression](#visitMethodCallExpression(org.codehaus.groovy.ast.expr.MethodCallExpression))([MethodCallExpression](../../../../../codehaus/groovy/ast/expr/methodcallexpression) call)` \| \| \| `void` \| `[visitVariableExpression](#visitVariableExpression(org.codehaus.groovy.ast.expr.VariableExpression))([VariableExpression](../../../../../codehaus/groovy/ast/expr/variableexpression) expression)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [GinqAstBaseVisitor](../../dsl/ginqastbasevisitor)` \| `[visit](../../dsl/ginqastbasevisitor#visit(org.apache.groovy.ginq.dsl.expression.AbstractGinqExpression)), [visitFromExpression](../../dsl/ginqastbasevisitor#visitFromExpression(org.apache.groovy.ginq.dsl.expression.FromExpression)), [visitGinqExpression](../../dsl/ginqastbasevisitor#visitGinqExpression(org.apache.groovy.ginq.dsl.expression.GinqExpression)), [visitGroupExpression](../../dsl/ginqastbasevisitor#visitGroupExpression(org.apache.groovy.ginq.dsl.expression.GroupExpression)), [visitHavingExpression](../../dsl/ginqastbasevisitor#visitHavingExpression(org.apache.groovy.ginq.dsl.expression.HavingExpression)), [visitJoinExpression](../../dsl/ginqastbasevisitor#visitJoinExpression(org.apache.groovy.ginq.dsl.expression.JoinExpression)), [visitLimitExpression](../../dsl/ginqastbasevisitor#visitLimitExpression(org.apache.groovy.ginq.dsl.expression.LimitExpression)), [visitOnExpression](../../dsl/ginqastbasevisitor#visitOnExpression(org.apache.groovy.ginq.dsl.expression.OnExpression)), [visitOrderExpression](../../dsl/ginqastbasevisitor#visitOrderExpression(org.apache.groovy.ginq.dsl.expression.OrderExpression)), [visitSelectExpression](../../dsl/ginqastbasevisitor#visitSelectExpression(org.apache.groovy.ginq.dsl.expression.SelectExpression)), [visitShutdownExpression](../../dsl/ginqastbasevisitor#visitShutdownExpression(org.apache.groovy.ginq.dsl.expression.ShutdownExpression)), [visitWhereExpression](../../dsl/ginqastbasevisitor#visitWhereExpression(org.apache.groovy.ginq.dsl.expression.WhereExpression))` \| \| `class [CodeVisitorSupport](../../../../../codehaus/groovy/ast/codevisitorsupport)` \| `[afterSwitchConditionExpressionVisited](../../../../../codehaus/groovy/ast/codevisitorsupport#afterSwitchConditionExpressionVisited(org.codehaus.groovy.ast.stmt.SwitchStatement)), [visitArgumentlistExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitArgumentlistExpression(org.codehaus.groovy.ast.expr.ArgumentListExpression)), [visitArrayExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitArrayExpression(org.codehaus.groovy.ast.expr.ArrayExpression)), [visitAssertStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitAssertStatement(org.codehaus.groovy.ast.stmt.AssertStatement)), [visitAttributeExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitAttributeExpression(org.codehaus.groovy.ast.expr.AttributeExpression)), [visitBinaryExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBinaryExpression(org.codehaus.groovy.ast.expr.BinaryExpression)), [visitBitwiseNegationExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBitwiseNegationExpression(org.codehaus.groovy.ast.expr.BitwiseNegationExpression)), [visitBlockStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBlockStatement(org.codehaus.groovy.ast.stmt.BlockStatement)), [visitBooleanExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBooleanExpression(org.codehaus.groovy.ast.expr.BooleanExpression)), [visitBreakStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBreakStatement(org.codehaus.groovy.ast.stmt.BreakStatement)), [visitBytecodeExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBytecodeExpression(org.codehaus.groovy.classgen.BytecodeExpression)), [visitCaseStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitCaseStatement(org.codehaus.groovy.ast.stmt.CaseStatement)), [visitCastExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitCastExpression(org.codehaus.groovy.ast.expr.CastExpression)), [visitCatchStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitCatchStatement(org.codehaus.groovy.ast.stmt.CatchStatement)), [visitClassExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitClassExpression(org.codehaus.groovy.ast.expr.ClassExpression)), [visitClosureExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitClosureExpression(org.codehaus.groovy.ast.expr.ClosureExpression)), [visitClosureListExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitClosureListExpression(org.codehaus.groovy.ast.expr.ClosureListExpression)), [visitConstantExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitConstantExpression(org.codehaus.groovy.ast.expr.ConstantExpression)), [visitConstructorCallExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitConstructorCallExpression(org.codehaus.groovy.ast.expr.ConstructorCallExpression)), [visitContinueStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitContinueStatement(org.codehaus.groovy.ast.stmt.ContinueStatement)), [visitDeclarationExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitDeclarationExpression(org.codehaus.groovy.ast.expr.DeclarationExpression)), [visitDoWhileLoop](../../../../../codehaus/groovy/ast/codevisitorsupport#visitDoWhileLoop(org.codehaus.groovy.ast.stmt.DoWhileStatement)), [visitEmptyStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitEmptyStatement(org.codehaus.groovy.ast.stmt.EmptyStatement)), [visitExpressionStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitExpressionStatement(org.codehaus.groovy.ast.stmt.ExpressionStatement)), [visitFieldExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitFieldExpression(org.codehaus.groovy.ast.expr.FieldExpression)), [visitForLoop](../../../../../codehaus/groovy/ast/codevisitorsupport#visitForLoop(org.codehaus.groovy.ast.stmt.ForStatement)), [visitGStringExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitGStringExpression(org.codehaus.groovy.ast.expr.GStringExpression)), [visitIfElse](../../../../../codehaus/groovy/ast/codevisitorsupport#visitIfElse(org.codehaus.groovy.ast.stmt.IfStatement)), [visitLambdaExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitLambdaExpression(org.codehaus.groovy.ast.expr.LambdaExpression)), [visitListExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitListExpression(org.codehaus.groovy.ast.expr.ListExpression)), [visitMapEntryExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitMapEntryExpression(org.codehaus.groovy.ast.expr.MapEntryExpression)), [visitMapExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitMapExpression(org.codehaus.groovy.ast.expr.MapExpression)), [visitMethodCallExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitMethodCallExpression(org.codehaus.groovy.ast.expr.MethodCallExpression)), [visitMethodPointerExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitMethodPointerExpression(org.codehaus.groovy.ast.expr.MethodPointerExpression)), [visitMethodReferenceExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitMethodReferenceExpression(org.codehaus.groovy.ast.expr.MethodReferenceExpression)), [visitNotExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitNotExpression(org.codehaus.groovy.ast.expr.NotExpression)), [visitPostfixExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitPostfixExpression(org.codehaus.groovy.ast.expr.PostfixExpression)), [visitPrefixExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitPrefixExpression(org.codehaus.groovy.ast.expr.PrefixExpression)), [visitPropertyExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitPropertyExpression(org.codehaus.groovy.ast.expr.PropertyExpression)), [visitRangeExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitRangeExpression(org.codehaus.groovy.ast.expr.RangeExpression)), [visitReturnStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitReturnStatement(org.codehaus.groovy.ast.stmt.ReturnStatement)), [visitShortTernaryExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitShortTernaryExpression(org.codehaus.groovy.ast.expr.ElvisOperatorExpression)), [visitSpreadExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitSpreadExpression(org.codehaus.groovy.ast.expr.SpreadExpression)), [visitSpreadMapExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitSpreadMapExpression(org.codehaus.groovy.ast.expr.SpreadMapExpression)), [visitStaticMethodCallExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitStaticMethodCallExpression(org.codehaus.groovy.ast.expr.StaticMethodCallExpression)), [visitSwitch](../../../../../codehaus/groovy/ast/codevisitorsupport#visitSwitch(org.codehaus.groovy.ast.stmt.SwitchStatement)), [visitSynchronizedStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitSynchronizedStatement(org.codehaus.groovy.ast.stmt.SynchronizedStatement)), [visitTernaryExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitTernaryExpression(org.codehaus.groovy.ast.expr.TernaryExpression)), [visitThrowStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitThrowStatement(org.codehaus.groovy.ast.stmt.ThrowStatement)), [visitTryCatchFinally](../../../../../codehaus/groovy/ast/codevisitorsupport#visitTryCatchFinally(org.codehaus.groovy.ast.stmt.TryCatchStatement)), [visitTupleExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitTupleExpression(org.codehaus.groovy.ast.expr.TupleExpression)), [visitUnaryMinusExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitUnaryMinusExpression(org.codehaus.groovy.ast.expr.UnaryMinusExpression)), [visitUnaryPlusExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitUnaryPlusExpression(org.codehaus.groovy.ast.expr.UnaryPlusExpression)), [visitVariableExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitVariableExpression(org.codehaus.groovy.ast.expr.VariableExpression)), [visitWhileLoop](../../../../../codehaus/groovy/ast/codevisitorsupport#visitWhileLoop(org.codehaus.groovy.ast.stmt.WhileStatement))` \| Constructor Detail ------------------ ### GinqAstWalker.6() Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") void visitMethodCallExpression([MethodCallExpression](../../../../../codehaus/groovy/ast/expr/methodcallexpression) call) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") void visitVariableExpression([VariableExpression](../../../../../codehaus/groovy/ast/expr/variableexpression) expression)	programming_docs
groovy [Groovy] Class GinqAstWalker.7 [Groovy] Class GinqAstWalker.7 ============================== * org.apache.groovy.ginq.provider.collection.GinqAstWalker.7 ``` class GinqAstWalker.7 extends [ExpressionTransformer](../../../../../codehaus/groovy/ast/expr/expressiontransformer) ``` Nested Class Summary -------------------- Nested classes \| Modifiers \| Name \| Description \| \| `class` \| `[GinqAstWalker.7.1](ginqastwalker.7.1)` \| \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[GinqAstWalker.7](#GinqAstWalker.7())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[transform](#transform(org.codehaus.groovy.ast.expr.Expression))([Expression](../../../../../codehaus/groovy/ast/expr/expression) expression)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `interface [ExpressionTransformer](../../../../../codehaus/groovy/ast/expr/expressiontransformer)` \| `[transform](../../../../../codehaus/groovy/ast/expr/expressiontransformer#transform(org.codehaus.groovy.ast.expr.Expression))` \| Constructor Detail ------------------ ### GinqAstWalker.7() Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") [Expression](../../../../../codehaus/groovy/ast/expr/expression) transform([Expression](../../../../../codehaus/groovy/ast/expr/expression) expression) groovy [Groovy] Class GinqAstWalker [Groovy] Class GinqAstWalker ============================ * org.apache.groovy.ginq.provider.collection.GinqAstWalker All Implemented Interfaces and Traits: GinqAstVisitor<Expression>, [SyntaxErrorReportable](../../dsl/syntaxerrorreportable) ``` @[CompileStatic](../../../../../../groovy/transform/compilestatic "CompileStatic") class GinqAstWalker extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") implements GinqAstVisitor<Expression>, [SyntaxErrorReportable](../../dsl/syntaxerrorreportable) ``` Visit AST of GINQ to generate target method calls for GINQ Since: 4.0.0 Nested Class Summary -------------------- Nested classes \| Modifiers \| Name \| Description \| \| `class` \| `[GinqAstWalker.1](ginqastwalker.1)` \| \| \| `class` \| `[GinqAstWalker.10](ginqastwalker.10)` \| \| \| `class` \| `[GinqAstWalker.11](ginqastwalker.11)` \| \| \| `class` \| `[GinqAstWalker.12](ginqastwalker.12)` \| \| \| `class` \| `[GinqAstWalker.13](ginqastwalker.13)` \| \| \| `class` \| `[GinqAstWalker.14](ginqastwalker.14)` \| \| \| `class` \| `[GinqAstWalker.2](ginqastwalker.2)` \| \| \| `class` \| `[GinqAstWalker.3](ginqastwalker.3)` \| \| \| `class` \| `[GinqAstWalker.4](ginqastwalker.4)` \| \| \| `class` \| `[GinqAstWalker.5](ginqastwalker.5)` \| \| \| `class` \| `[GinqAstWalker.6](ginqastwalker.6)` \| \| \| `class` \| `[GinqAstWalker.7](ginqastwalker.7)` \| \| \| `class` \| `[GinqAstWalker.8](ginqastwalker.8)` \| \| \| `class` \| `[GinqAstWalker.9](ginqastwalker.9)` \| \| Properties Summary ------------------ Properties \| Type \| Name and description \| \| `[Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>` \| `[configuration](#configuration)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[GinqAstWalker](#GinqAstWalker(org.codehaus.groovy.control.SourceUnit))([SourceUnit](../../../../../codehaus/groovy/control/sourceunit) sourceUnit)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>` \| `[getConfiguration](#getConfiguration())()` \| \| \| `[SourceUnit](../../../../../codehaus/groovy/control/sourceunit)` \| `[getSourceUnit](#getSourceUnit())()` \| \| \| `void` \| `[setConfiguration](#setConfiguration(Map))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> configuration)` \| \| \| `[Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[visit](#visit(org.apache.groovy.ginq.dsl.expression.AbstractGinqExpression))([AbstractGinqExpression](../../dsl/expression/abstractginqexpression) expression)` \| \| \| `[MethodCallExpression](../../../../../codehaus/groovy/ast/expr/methodcallexpression)` \| `[visitFromExpression](#visitFromExpression(org.apache.groovy.ginq.dsl.expression.FromExpression))([FromExpression](../../dsl/expression/fromexpression) fromExpression)` \| \| \| `[MethodCallExpression](../../../../../codehaus/groovy/ast/expr/methodcallexpression)` \| `[visitGinqExpression](#visitGinqExpression(org.apache.groovy.ginq.dsl.expression.GinqExpression))([GinqExpression](../../dsl/expression/ginqexpression) ginqExpression)` \| \| \| `[MethodCallExpression](../../../../../codehaus/groovy/ast/expr/methodcallexpression)` \| `[visitGroupExpression](#visitGroupExpression(org.apache.groovy.ginq.dsl.expression.GroupExpression))([GroupExpression](../../dsl/expression/groupexpression) groupExpression)` \| \| \| `[Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[visitHavingExpression](#visitHavingExpression(org.apache.groovy.ginq.dsl.expression.HavingExpression))([HavingExpression](../../dsl/expression/havingexpression) havingExpression)` \| \| \| `[MethodCallExpression](../../../../../codehaus/groovy/ast/expr/methodcallexpression)` \| `[visitJoinExpression](#visitJoinExpression(org.apache.groovy.ginq.dsl.expression.JoinExpression))([JoinExpression](../../dsl/expression/joinexpression) joinExpression)` \| \| \| `[MethodCallExpression](../../../../../codehaus/groovy/ast/expr/methodcallexpression)` \| `[visitLimitExpression](#visitLimitExpression(org.apache.groovy.ginq.dsl.expression.LimitExpression))([LimitExpression](../../dsl/expression/limitexpression) limitExpression)` \| \| \| `[MethodCallExpression](../../../../../codehaus/groovy/ast/expr/methodcallexpression)` \| `[visitOnExpression](#visitOnExpression(org.apache.groovy.ginq.dsl.expression.OnExpression))([OnExpression](../../dsl/expression/onexpression) onExpression)` \| \| \| `[MethodCallExpression](../../../../../codehaus/groovy/ast/expr/methodcallexpression)` \| `[visitOrderExpression](#visitOrderExpression(org.apache.groovy.ginq.dsl.expression.OrderExpression))([OrderExpression](../../dsl/expression/orderexpression) orderExpression)` \| \| \| `[MethodCallExpression](../../../../../codehaus/groovy/ast/expr/methodcallexpression)` \| `[visitSelectExpression](#visitSelectExpression(org.apache.groovy.ginq.dsl.expression.SelectExpression))([SelectExpression](../../dsl/expression/selectexpression) selectExpression)` \| \| \| `[Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[visitShutdownExpression](#visitShutdownExpression(org.apache.groovy.ginq.dsl.expression.ShutdownExpression))([ShutdownExpression](../../dsl/expression/shutdownexpression) shutdownExpression)` \| \| \| `[MethodCallExpression](../../../../../codehaus/groovy/ast/expr/methodcallexpression)` \| `[visitWhereExpression](#visitWhereExpression(org.apache.groovy.ginq.dsl.expression.WhereExpression))([WhereExpression](../../dsl/expression/whereexpression) whereExpression)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Property Detail --------------- ### [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> configuration Constructor Detail ------------------ ### GinqAstWalker([SourceUnit](../../../../../codehaus/groovy/control/sourceunit) sourceUnit) Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> getConfiguration() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") [SourceUnit](../../../../../codehaus/groovy/control/sourceunit) getSourceUnit() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") void setConfiguration([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> configuration) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") [Expression](../../../../../codehaus/groovy/ast/expr/expression) visit([AbstractGinqExpression](../../dsl/expression/abstractginqexpression) expression) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") [MethodCallExpression](../../../../../codehaus/groovy/ast/expr/methodcallexpression) visitFromExpression([FromExpression](../../dsl/expression/fromexpression) fromExpression) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") [MethodCallExpression](../../../../../codehaus/groovy/ast/expr/methodcallexpression) visitGinqExpression([GinqExpression](../../dsl/expression/ginqexpression) ginqExpression) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") [MethodCallExpression](../../../../../codehaus/groovy/ast/expr/methodcallexpression) visitGroupExpression([GroupExpression](../../dsl/expression/groupexpression) groupExpression) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") [Expression](../../../../../codehaus/groovy/ast/expr/expression) visitHavingExpression([HavingExpression](../../dsl/expression/havingexpression) havingExpression) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") [MethodCallExpression](../../../../../codehaus/groovy/ast/expr/methodcallexpression) visitJoinExpression([JoinExpression](../../dsl/expression/joinexpression) joinExpression) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") [MethodCallExpression](../../../../../codehaus/groovy/ast/expr/methodcallexpression) visitLimitExpression([LimitExpression](../../dsl/expression/limitexpression) limitExpression) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") [MethodCallExpression](../../../../../codehaus/groovy/ast/expr/methodcallexpression) visitOnExpression([OnExpression](../../dsl/expression/onexpression) onExpression) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") [MethodCallExpression](../../../../../codehaus/groovy/ast/expr/methodcallexpression) visitOrderExpression([OrderExpression](../../dsl/expression/orderexpression) orderExpression) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") [MethodCallExpression](../../../../../codehaus/groovy/ast/expr/methodcallexpression) visitSelectExpression([SelectExpression](../../dsl/expression/selectexpression) selectExpression) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") [Expression](../../../../../codehaus/groovy/ast/expr/expression) visitShutdownExpression([ShutdownExpression](../../dsl/expression/shutdownexpression) shutdownExpression) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") [MethodCallExpression](../../../../../codehaus/groovy/ast/expr/methodcallexpression) visitWhereExpression([WhereExpression](../../dsl/expression/whereexpression) whereExpression) groovy [Groovy] Class GinqAstWalker.12 [Groovy] Class GinqAstWalker.12 =============================== * org.apache.groovy.ginq.provider.collection.GinqAstWalker.12 ``` class GinqAstWalker.12 extends [GinqAstBaseVisitor](../../dsl/ginqastbasevisitor) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[GinqAstWalker.12](#GinqAstWalker.12())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `void` \| `[visitVariableExpression](#visitVariableExpression(org.codehaus.groovy.ast.expr.VariableExpression))([VariableExpression](../../../../../codehaus/groovy/ast/expr/variableexpression) expression)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [GinqAstBaseVisitor](../../dsl/ginqastbasevisitor)` \| `[visit](../../dsl/ginqastbasevisitor#visit(org.apache.groovy.ginq.dsl.expression.AbstractGinqExpression)), [visitFromExpression](../../dsl/ginqastbasevisitor#visitFromExpression(org.apache.groovy.ginq.dsl.expression.FromExpression)), [visitGinqExpression](../../dsl/ginqastbasevisitor#visitGinqExpression(org.apache.groovy.ginq.dsl.expression.GinqExpression)), [visitGroupExpression](../../dsl/ginqastbasevisitor#visitGroupExpression(org.apache.groovy.ginq.dsl.expression.GroupExpression)), [visitHavingExpression](../../dsl/ginqastbasevisitor#visitHavingExpression(org.apache.groovy.ginq.dsl.expression.HavingExpression)), [visitJoinExpression](../../dsl/ginqastbasevisitor#visitJoinExpression(org.apache.groovy.ginq.dsl.expression.JoinExpression)), [visitLimitExpression](../../dsl/ginqastbasevisitor#visitLimitExpression(org.apache.groovy.ginq.dsl.expression.LimitExpression)), [visitOnExpression](../../dsl/ginqastbasevisitor#visitOnExpression(org.apache.groovy.ginq.dsl.expression.OnExpression)), [visitOrderExpression](../../dsl/ginqastbasevisitor#visitOrderExpression(org.apache.groovy.ginq.dsl.expression.OrderExpression)), [visitSelectExpression](../../dsl/ginqastbasevisitor#visitSelectExpression(org.apache.groovy.ginq.dsl.expression.SelectExpression)), [visitShutdownExpression](../../dsl/ginqastbasevisitor#visitShutdownExpression(org.apache.groovy.ginq.dsl.expression.ShutdownExpression)), [visitWhereExpression](../../dsl/ginqastbasevisitor#visitWhereExpression(org.apache.groovy.ginq.dsl.expression.WhereExpression))` \| \| `class [CodeVisitorSupport](../../../../../codehaus/groovy/ast/codevisitorsupport)` \| `[afterSwitchConditionExpressionVisited](../../../../../codehaus/groovy/ast/codevisitorsupport#afterSwitchConditionExpressionVisited(org.codehaus.groovy.ast.stmt.SwitchStatement)), [visitArgumentlistExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitArgumentlistExpression(org.codehaus.groovy.ast.expr.ArgumentListExpression)), [visitArrayExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitArrayExpression(org.codehaus.groovy.ast.expr.ArrayExpression)), [visitAssertStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitAssertStatement(org.codehaus.groovy.ast.stmt.AssertStatement)), [visitAttributeExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitAttributeExpression(org.codehaus.groovy.ast.expr.AttributeExpression)), [visitBinaryExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBinaryExpression(org.codehaus.groovy.ast.expr.BinaryExpression)), [visitBitwiseNegationExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBitwiseNegationExpression(org.codehaus.groovy.ast.expr.BitwiseNegationExpression)), [visitBlockStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBlockStatement(org.codehaus.groovy.ast.stmt.BlockStatement)), [visitBooleanExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBooleanExpression(org.codehaus.groovy.ast.expr.BooleanExpression)), [visitBreakStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBreakStatement(org.codehaus.groovy.ast.stmt.BreakStatement)), [visitBytecodeExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBytecodeExpression(org.codehaus.groovy.classgen.BytecodeExpression)), [visitCaseStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitCaseStatement(org.codehaus.groovy.ast.stmt.CaseStatement)), [visitCastExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitCastExpression(org.codehaus.groovy.ast.expr.CastExpression)), [visitCatchStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitCatchStatement(org.codehaus.groovy.ast.stmt.CatchStatement)), [visitClassExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitClassExpression(org.codehaus.groovy.ast.expr.ClassExpression)), [visitClosureExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitClosureExpression(org.codehaus.groovy.ast.expr.ClosureExpression)), [visitClosureListExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitClosureListExpression(org.codehaus.groovy.ast.expr.ClosureListExpression)), [visitConstantExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitConstantExpression(org.codehaus.groovy.ast.expr.ConstantExpression)), [visitConstructorCallExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitConstructorCallExpression(org.codehaus.groovy.ast.expr.ConstructorCallExpression)), [visitContinueStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitContinueStatement(org.codehaus.groovy.ast.stmt.ContinueStatement)), [visitDeclarationExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitDeclarationExpression(org.codehaus.groovy.ast.expr.DeclarationExpression)), [visitDoWhileLoop](../../../../../codehaus/groovy/ast/codevisitorsupport#visitDoWhileLoop(org.codehaus.groovy.ast.stmt.DoWhileStatement)), [visitEmptyStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitEmptyStatement(org.codehaus.groovy.ast.stmt.EmptyStatement)), [visitExpressionStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitExpressionStatement(org.codehaus.groovy.ast.stmt.ExpressionStatement)), [visitFieldExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitFieldExpression(org.codehaus.groovy.ast.expr.FieldExpression)), [visitForLoop](../../../../../codehaus/groovy/ast/codevisitorsupport#visitForLoop(org.codehaus.groovy.ast.stmt.ForStatement)), [visitGStringExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitGStringExpression(org.codehaus.groovy.ast.expr.GStringExpression)), [visitIfElse](../../../../../codehaus/groovy/ast/codevisitorsupport#visitIfElse(org.codehaus.groovy.ast.stmt.IfStatement)), [visitLambdaExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitLambdaExpression(org.codehaus.groovy.ast.expr.LambdaExpression)), [visitListExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitListExpression(org.codehaus.groovy.ast.expr.ListExpression)), [visitMapEntryExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitMapEntryExpression(org.codehaus.groovy.ast.expr.MapEntryExpression)), [visitMapExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitMapExpression(org.codehaus.groovy.ast.expr.MapExpression)), [visitMethodCallExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitMethodCallExpression(org.codehaus.groovy.ast.expr.MethodCallExpression)), [visitMethodPointerExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitMethodPointerExpression(org.codehaus.groovy.ast.expr.MethodPointerExpression)), [visitMethodReferenceExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitMethodReferenceExpression(org.codehaus.groovy.ast.expr.MethodReferenceExpression)), [visitNotExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitNotExpression(org.codehaus.groovy.ast.expr.NotExpression)), [visitPostfixExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitPostfixExpression(org.codehaus.groovy.ast.expr.PostfixExpression)), [visitPrefixExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitPrefixExpression(org.codehaus.groovy.ast.expr.PrefixExpression)), [visitPropertyExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitPropertyExpression(org.codehaus.groovy.ast.expr.PropertyExpression)), [visitRangeExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitRangeExpression(org.codehaus.groovy.ast.expr.RangeExpression)), [visitReturnStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitReturnStatement(org.codehaus.groovy.ast.stmt.ReturnStatement)), [visitShortTernaryExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitShortTernaryExpression(org.codehaus.groovy.ast.expr.ElvisOperatorExpression)), [visitSpreadExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitSpreadExpression(org.codehaus.groovy.ast.expr.SpreadExpression)), [visitSpreadMapExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitSpreadMapExpression(org.codehaus.groovy.ast.expr.SpreadMapExpression)), [visitStaticMethodCallExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitStaticMethodCallExpression(org.codehaus.groovy.ast.expr.StaticMethodCallExpression)), [visitSwitch](../../../../../codehaus/groovy/ast/codevisitorsupport#visitSwitch(org.codehaus.groovy.ast.stmt.SwitchStatement)), [visitSynchronizedStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitSynchronizedStatement(org.codehaus.groovy.ast.stmt.SynchronizedStatement)), [visitTernaryExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitTernaryExpression(org.codehaus.groovy.ast.expr.TernaryExpression)), [visitThrowStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitThrowStatement(org.codehaus.groovy.ast.stmt.ThrowStatement)), [visitTryCatchFinally](../../../../../codehaus/groovy/ast/codevisitorsupport#visitTryCatchFinally(org.codehaus.groovy.ast.stmt.TryCatchStatement)), [visitTupleExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitTupleExpression(org.codehaus.groovy.ast.expr.TupleExpression)), [visitUnaryMinusExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitUnaryMinusExpression(org.codehaus.groovy.ast.expr.UnaryMinusExpression)), [visitUnaryPlusExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitUnaryPlusExpression(org.codehaus.groovy.ast.expr.UnaryPlusExpression)), [visitVariableExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitVariableExpression(org.codehaus.groovy.ast.expr.VariableExpression)), [visitWhileLoop](../../../../../codehaus/groovy/ast/codevisitorsupport#visitWhileLoop(org.codehaus.groovy.ast.stmt.WhileStatement))` \| Constructor Detail ------------------ ### GinqAstWalker.12() Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") void visitVariableExpression([VariableExpression](../../../../../codehaus/groovy/ast/expr/variableexpression) expression)	programming_docs
groovy [Groovy] Class GinqAstWalker.8 [Groovy] Class GinqAstWalker.8 ============================== * org.apache.groovy.ginq.provider.collection.GinqAstWalker.8 ``` class GinqAstWalker.8 extends [CodeVisitorSupport](../../../../../codehaus/groovy/ast/codevisitorsupport) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[GinqAstWalker.8](#GinqAstWalker.8())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `void` \| `[visitMethodCallExpression](#visitMethodCallExpression(org.codehaus.groovy.ast.expr.MethodCallExpression))([MethodCallExpression](../../../../../codehaus/groovy/ast/expr/methodcallexpression) call)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [CodeVisitorSupport](../../../../../codehaus/groovy/ast/codevisitorsupport)` \| `[afterSwitchConditionExpressionVisited](../../../../../codehaus/groovy/ast/codevisitorsupport#afterSwitchConditionExpressionVisited(org.codehaus.groovy.ast.stmt.SwitchStatement)), [visitArgumentlistExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitArgumentlistExpression(org.codehaus.groovy.ast.expr.ArgumentListExpression)), [visitArrayExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitArrayExpression(org.codehaus.groovy.ast.expr.ArrayExpression)), [visitAssertStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitAssertStatement(org.codehaus.groovy.ast.stmt.AssertStatement)), [visitAttributeExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitAttributeExpression(org.codehaus.groovy.ast.expr.AttributeExpression)), [visitBinaryExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBinaryExpression(org.codehaus.groovy.ast.expr.BinaryExpression)), [visitBitwiseNegationExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBitwiseNegationExpression(org.codehaus.groovy.ast.expr.BitwiseNegationExpression)), [visitBlockStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBlockStatement(org.codehaus.groovy.ast.stmt.BlockStatement)), [visitBooleanExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBooleanExpression(org.codehaus.groovy.ast.expr.BooleanExpression)), [visitBreakStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBreakStatement(org.codehaus.groovy.ast.stmt.BreakStatement)), [visitBytecodeExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBytecodeExpression(org.codehaus.groovy.classgen.BytecodeExpression)), [visitCaseStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitCaseStatement(org.codehaus.groovy.ast.stmt.CaseStatement)), [visitCastExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitCastExpression(org.codehaus.groovy.ast.expr.CastExpression)), [visitCatchStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitCatchStatement(org.codehaus.groovy.ast.stmt.CatchStatement)), [visitClassExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitClassExpression(org.codehaus.groovy.ast.expr.ClassExpression)), [visitClosureExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitClosureExpression(org.codehaus.groovy.ast.expr.ClosureExpression)), [visitClosureListExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitClosureListExpression(org.codehaus.groovy.ast.expr.ClosureListExpression)), [visitConstantExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitConstantExpression(org.codehaus.groovy.ast.expr.ConstantExpression)), [visitConstructorCallExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitConstructorCallExpression(org.codehaus.groovy.ast.expr.ConstructorCallExpression)), [visitContinueStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitContinueStatement(org.codehaus.groovy.ast.stmt.ContinueStatement)), [visitDeclarationExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitDeclarationExpression(org.codehaus.groovy.ast.expr.DeclarationExpression)), [visitDoWhileLoop](../../../../../codehaus/groovy/ast/codevisitorsupport#visitDoWhileLoop(org.codehaus.groovy.ast.stmt.DoWhileStatement)), [visitEmptyStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitEmptyStatement(org.codehaus.groovy.ast.stmt.EmptyStatement)), [visitExpressionStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitExpressionStatement(org.codehaus.groovy.ast.stmt.ExpressionStatement)), [visitFieldExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitFieldExpression(org.codehaus.groovy.ast.expr.FieldExpression)), [visitForLoop](../../../../../codehaus/groovy/ast/codevisitorsupport#visitForLoop(org.codehaus.groovy.ast.stmt.ForStatement)), [visitGStringExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitGStringExpression(org.codehaus.groovy.ast.expr.GStringExpression)), [visitIfElse](../../../../../codehaus/groovy/ast/codevisitorsupport#visitIfElse(org.codehaus.groovy.ast.stmt.IfStatement)), [visitLambdaExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitLambdaExpression(org.codehaus.groovy.ast.expr.LambdaExpression)), [visitListExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitListExpression(org.codehaus.groovy.ast.expr.ListExpression)), [visitMapEntryExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitMapEntryExpression(org.codehaus.groovy.ast.expr.MapEntryExpression)), [visitMapExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitMapExpression(org.codehaus.groovy.ast.expr.MapExpression)), [visitMethodCallExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitMethodCallExpression(org.codehaus.groovy.ast.expr.MethodCallExpression)), [visitMethodPointerExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitMethodPointerExpression(org.codehaus.groovy.ast.expr.MethodPointerExpression)), [visitMethodReferenceExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitMethodReferenceExpression(org.codehaus.groovy.ast.expr.MethodReferenceExpression)), [visitNotExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitNotExpression(org.codehaus.groovy.ast.expr.NotExpression)), [visitPostfixExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitPostfixExpression(org.codehaus.groovy.ast.expr.PostfixExpression)), [visitPrefixExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitPrefixExpression(org.codehaus.groovy.ast.expr.PrefixExpression)), [visitPropertyExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitPropertyExpression(org.codehaus.groovy.ast.expr.PropertyExpression)), [visitRangeExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitRangeExpression(org.codehaus.groovy.ast.expr.RangeExpression)), [visitReturnStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitReturnStatement(org.codehaus.groovy.ast.stmt.ReturnStatement)), [visitShortTernaryExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitShortTernaryExpression(org.codehaus.groovy.ast.expr.ElvisOperatorExpression)), [visitSpreadExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitSpreadExpression(org.codehaus.groovy.ast.expr.SpreadExpression)), [visitSpreadMapExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitSpreadMapExpression(org.codehaus.groovy.ast.expr.SpreadMapExpression)), [visitStaticMethodCallExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitStaticMethodCallExpression(org.codehaus.groovy.ast.expr.StaticMethodCallExpression)), [visitSwitch](../../../../../codehaus/groovy/ast/codevisitorsupport#visitSwitch(org.codehaus.groovy.ast.stmt.SwitchStatement)), [visitSynchronizedStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitSynchronizedStatement(org.codehaus.groovy.ast.stmt.SynchronizedStatement)), [visitTernaryExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitTernaryExpression(org.codehaus.groovy.ast.expr.TernaryExpression)), [visitThrowStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitThrowStatement(org.codehaus.groovy.ast.stmt.ThrowStatement)), [visitTryCatchFinally](../../../../../codehaus/groovy/ast/codevisitorsupport#visitTryCatchFinally(org.codehaus.groovy.ast.stmt.TryCatchStatement)), [visitTupleExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitTupleExpression(org.codehaus.groovy.ast.expr.TupleExpression)), [visitUnaryMinusExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitUnaryMinusExpression(org.codehaus.groovy.ast.expr.UnaryMinusExpression)), [visitUnaryPlusExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitUnaryPlusExpression(org.codehaus.groovy.ast.expr.UnaryPlusExpression)), [visitVariableExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitVariableExpression(org.codehaus.groovy.ast.expr.VariableExpression)), [visitWhileLoop](../../../../../codehaus/groovy/ast/codevisitorsupport#visitWhileLoop(org.codehaus.groovy.ast.stmt.WhileStatement))` \| Constructor Detail ------------------ ### GinqAstWalker.8() Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") void visitMethodCallExpression([MethodCallExpression](../../../../../codehaus/groovy/ast/expr/methodcallexpression) call) groovy [Groovy] Class GinqAstWalker.11 [Groovy] Class GinqAstWalker.11 =============================== * org.apache.groovy.ginq.provider.collection.GinqAstWalker.11 ``` class GinqAstWalker.11 extends [ExpressionTransformer](../../../../../codehaus/groovy/ast/expr/expressiontransformer) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[GinqAstWalker.11](#GinqAstWalker.11())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[transform](#transform(org.codehaus.groovy.ast.expr.Expression))([Expression](../../../../../codehaus/groovy/ast/expr/expression) expr)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `interface [ExpressionTransformer](../../../../../codehaus/groovy/ast/expr/expressiontransformer)` \| `[transform](../../../../../codehaus/groovy/ast/expr/expressiontransformer#transform(org.codehaus.groovy.ast.expr.Expression))` \| Constructor Detail ------------------ ### GinqAstWalker.11() Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") [Expression](../../../../../codehaus/groovy/ast/expr/expression) transform([Expression](../../../../../codehaus/groovy/ast/expr/expression) expr) groovy [Groovy] Class GinqAstWalker.4 [Groovy] Class GinqAstWalker.4 ============================== * org.apache.groovy.ginq.provider.collection.GinqAstWalker.4 ``` class GinqAstWalker.4 extends [CodeVisitorSupport](../../../../../codehaus/groovy/ast/codevisitorsupport) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[GinqAstWalker.4](#GinqAstWalker.4())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `void` \| `[visitVariableExpression](#visitVariableExpression(org.codehaus.groovy.ast.expr.VariableExpression))([VariableExpression](../../../../../codehaus/groovy/ast/expr/variableexpression) expr)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [CodeVisitorSupport](../../../../../codehaus/groovy/ast/codevisitorsupport)` \| `[afterSwitchConditionExpressionVisited](../../../../../codehaus/groovy/ast/codevisitorsupport#afterSwitchConditionExpressionVisited(org.codehaus.groovy.ast.stmt.SwitchStatement)), [visitArgumentlistExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitArgumentlistExpression(org.codehaus.groovy.ast.expr.ArgumentListExpression)), [visitArrayExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitArrayExpression(org.codehaus.groovy.ast.expr.ArrayExpression)), [visitAssertStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitAssertStatement(org.codehaus.groovy.ast.stmt.AssertStatement)), [visitAttributeExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitAttributeExpression(org.codehaus.groovy.ast.expr.AttributeExpression)), [visitBinaryExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBinaryExpression(org.codehaus.groovy.ast.expr.BinaryExpression)), [visitBitwiseNegationExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBitwiseNegationExpression(org.codehaus.groovy.ast.expr.BitwiseNegationExpression)), [visitBlockStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBlockStatement(org.codehaus.groovy.ast.stmt.BlockStatement)), [visitBooleanExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBooleanExpression(org.codehaus.groovy.ast.expr.BooleanExpression)), [visitBreakStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBreakStatement(org.codehaus.groovy.ast.stmt.BreakStatement)), [visitBytecodeExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBytecodeExpression(org.codehaus.groovy.classgen.BytecodeExpression)), [visitCaseStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitCaseStatement(org.codehaus.groovy.ast.stmt.CaseStatement)), [visitCastExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitCastExpression(org.codehaus.groovy.ast.expr.CastExpression)), [visitCatchStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitCatchStatement(org.codehaus.groovy.ast.stmt.CatchStatement)), [visitClassExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitClassExpression(org.codehaus.groovy.ast.expr.ClassExpression)), [visitClosureExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitClosureExpression(org.codehaus.groovy.ast.expr.ClosureExpression)), [visitClosureListExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitClosureListExpression(org.codehaus.groovy.ast.expr.ClosureListExpression)), [visitConstantExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitConstantExpression(org.codehaus.groovy.ast.expr.ConstantExpression)), [visitConstructorCallExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitConstructorCallExpression(org.codehaus.groovy.ast.expr.ConstructorCallExpression)), [visitContinueStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitContinueStatement(org.codehaus.groovy.ast.stmt.ContinueStatement)), [visitDeclarationExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitDeclarationExpression(org.codehaus.groovy.ast.expr.DeclarationExpression)), [visitDoWhileLoop](../../../../../codehaus/groovy/ast/codevisitorsupport#visitDoWhileLoop(org.codehaus.groovy.ast.stmt.DoWhileStatement)), [visitEmptyStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitEmptyStatement(org.codehaus.groovy.ast.stmt.EmptyStatement)), [visitExpressionStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitExpressionStatement(org.codehaus.groovy.ast.stmt.ExpressionStatement)), [visitFieldExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitFieldExpression(org.codehaus.groovy.ast.expr.FieldExpression)), [visitForLoop](../../../../../codehaus/groovy/ast/codevisitorsupport#visitForLoop(org.codehaus.groovy.ast.stmt.ForStatement)), [visitGStringExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitGStringExpression(org.codehaus.groovy.ast.expr.GStringExpression)), [visitIfElse](../../../../../codehaus/groovy/ast/codevisitorsupport#visitIfElse(org.codehaus.groovy.ast.stmt.IfStatement)), [visitLambdaExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitLambdaExpression(org.codehaus.groovy.ast.expr.LambdaExpression)), [visitListExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitListExpression(org.codehaus.groovy.ast.expr.ListExpression)), [visitMapEntryExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitMapEntryExpression(org.codehaus.groovy.ast.expr.MapEntryExpression)), [visitMapExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitMapExpression(org.codehaus.groovy.ast.expr.MapExpression)), [visitMethodCallExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitMethodCallExpression(org.codehaus.groovy.ast.expr.MethodCallExpression)), [visitMethodPointerExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitMethodPointerExpression(org.codehaus.groovy.ast.expr.MethodPointerExpression)), [visitMethodReferenceExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitMethodReferenceExpression(org.codehaus.groovy.ast.expr.MethodReferenceExpression)), [visitNotExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitNotExpression(org.codehaus.groovy.ast.expr.NotExpression)), [visitPostfixExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitPostfixExpression(org.codehaus.groovy.ast.expr.PostfixExpression)), [visitPrefixExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitPrefixExpression(org.codehaus.groovy.ast.expr.PrefixExpression)), [visitPropertyExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitPropertyExpression(org.codehaus.groovy.ast.expr.PropertyExpression)), [visitRangeExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitRangeExpression(org.codehaus.groovy.ast.expr.RangeExpression)), [visitReturnStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitReturnStatement(org.codehaus.groovy.ast.stmt.ReturnStatement)), [visitShortTernaryExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitShortTernaryExpression(org.codehaus.groovy.ast.expr.ElvisOperatorExpression)), [visitSpreadExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitSpreadExpression(org.codehaus.groovy.ast.expr.SpreadExpression)), [visitSpreadMapExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitSpreadMapExpression(org.codehaus.groovy.ast.expr.SpreadMapExpression)), [visitStaticMethodCallExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitStaticMethodCallExpression(org.codehaus.groovy.ast.expr.StaticMethodCallExpression)), [visitSwitch](../../../../../codehaus/groovy/ast/codevisitorsupport#visitSwitch(org.codehaus.groovy.ast.stmt.SwitchStatement)), [visitSynchronizedStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitSynchronizedStatement(org.codehaus.groovy.ast.stmt.SynchronizedStatement)), [visitTernaryExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitTernaryExpression(org.codehaus.groovy.ast.expr.TernaryExpression)), [visitThrowStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitThrowStatement(org.codehaus.groovy.ast.stmt.ThrowStatement)), [visitTryCatchFinally](../../../../../codehaus/groovy/ast/codevisitorsupport#visitTryCatchFinally(org.codehaus.groovy.ast.stmt.TryCatchStatement)), [visitTupleExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitTupleExpression(org.codehaus.groovy.ast.expr.TupleExpression)), [visitUnaryMinusExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitUnaryMinusExpression(org.codehaus.groovy.ast.expr.UnaryMinusExpression)), [visitUnaryPlusExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitUnaryPlusExpression(org.codehaus.groovy.ast.expr.UnaryPlusExpression)), [visitVariableExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitVariableExpression(org.codehaus.groovy.ast.expr.VariableExpression)), [visitWhileLoop](../../../../../codehaus/groovy/ast/codevisitorsupport#visitWhileLoop(org.codehaus.groovy.ast.stmt.WhileStatement))` \| Constructor Detail ------------------ ### GinqAstWalker.4() Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") void visitVariableExpression([VariableExpression](../../../../../codehaus/groovy/ast/expr/variableexpression) expr)	programming_docs
groovy [Groovy] Class GinqAstWalker.5 [Groovy] Class GinqAstWalker.5 ============================== * org.apache.groovy.ginq.provider.collection.GinqAstWalker.5 ``` class GinqAstWalker.5 extends [ExpressionTransformer](../../../../../codehaus/groovy/ast/expr/expressiontransformer) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[GinqAstWalker.5](#GinqAstWalker.5())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[transform](#transform(org.codehaus.groovy.ast.expr.Expression))([Expression](../../../../../codehaus/groovy/ast/expr/expression) expression)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `interface [ExpressionTransformer](../../../../../codehaus/groovy/ast/expr/expressiontransformer)` \| `[transform](../../../../../codehaus/groovy/ast/expr/expressiontransformer#transform(org.codehaus.groovy.ast.expr.Expression))` \| Constructor Detail ------------------ ### GinqAstWalker.5() Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") [Expression](../../../../../codehaus/groovy/ast/expr/expression) transform([Expression](../../../../../codehaus/groovy/ast/expr/expression) expression) groovy [Groovy] Class GinqAstWalker.10 [Groovy] Class GinqAstWalker.10 =============================== * org.apache.groovy.ginq.provider.collection.GinqAstWalker.10 ``` class GinqAstWalker.10 extends [GinqAstBaseVisitor](../../dsl/ginqastbasevisitor) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[GinqAstWalker.10](#GinqAstWalker.10())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `void` \| `[visitMethodCallExpression](#visitMethodCallExpression(org.codehaus.groovy.ast.expr.MethodCallExpression))([MethodCallExpression](../../../../../codehaus/groovy/ast/expr/methodcallexpression) call)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [GinqAstBaseVisitor](../../dsl/ginqastbasevisitor)` \| `[visit](../../dsl/ginqastbasevisitor#visit(org.apache.groovy.ginq.dsl.expression.AbstractGinqExpression)), [visitFromExpression](../../dsl/ginqastbasevisitor#visitFromExpression(org.apache.groovy.ginq.dsl.expression.FromExpression)), [visitGinqExpression](../../dsl/ginqastbasevisitor#visitGinqExpression(org.apache.groovy.ginq.dsl.expression.GinqExpression)), [visitGroupExpression](../../dsl/ginqastbasevisitor#visitGroupExpression(org.apache.groovy.ginq.dsl.expression.GroupExpression)), [visitHavingExpression](../../dsl/ginqastbasevisitor#visitHavingExpression(org.apache.groovy.ginq.dsl.expression.HavingExpression)), [visitJoinExpression](../../dsl/ginqastbasevisitor#visitJoinExpression(org.apache.groovy.ginq.dsl.expression.JoinExpression)), [visitLimitExpression](../../dsl/ginqastbasevisitor#visitLimitExpression(org.apache.groovy.ginq.dsl.expression.LimitExpression)), [visitOnExpression](../../dsl/ginqastbasevisitor#visitOnExpression(org.apache.groovy.ginq.dsl.expression.OnExpression)), [visitOrderExpression](../../dsl/ginqastbasevisitor#visitOrderExpression(org.apache.groovy.ginq.dsl.expression.OrderExpression)), [visitSelectExpression](../../dsl/ginqastbasevisitor#visitSelectExpression(org.apache.groovy.ginq.dsl.expression.SelectExpression)), [visitShutdownExpression](../../dsl/ginqastbasevisitor#visitShutdownExpression(org.apache.groovy.ginq.dsl.expression.ShutdownExpression)), [visitWhereExpression](../../dsl/ginqastbasevisitor#visitWhereExpression(org.apache.groovy.ginq.dsl.expression.WhereExpression))` \| \| `class [CodeVisitorSupport](../../../../../codehaus/groovy/ast/codevisitorsupport)` \| `[afterSwitchConditionExpressionVisited](../../../../../codehaus/groovy/ast/codevisitorsupport#afterSwitchConditionExpressionVisited(org.codehaus.groovy.ast.stmt.SwitchStatement)), [visitArgumentlistExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitArgumentlistExpression(org.codehaus.groovy.ast.expr.ArgumentListExpression)), [visitArrayExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitArrayExpression(org.codehaus.groovy.ast.expr.ArrayExpression)), [visitAssertStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitAssertStatement(org.codehaus.groovy.ast.stmt.AssertStatement)), [visitAttributeExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitAttributeExpression(org.codehaus.groovy.ast.expr.AttributeExpression)), [visitBinaryExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBinaryExpression(org.codehaus.groovy.ast.expr.BinaryExpression)), [visitBitwiseNegationExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBitwiseNegationExpression(org.codehaus.groovy.ast.expr.BitwiseNegationExpression)), [visitBlockStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBlockStatement(org.codehaus.groovy.ast.stmt.BlockStatement)), [visitBooleanExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBooleanExpression(org.codehaus.groovy.ast.expr.BooleanExpression)), [visitBreakStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBreakStatement(org.codehaus.groovy.ast.stmt.BreakStatement)), [visitBytecodeExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBytecodeExpression(org.codehaus.groovy.classgen.BytecodeExpression)), [visitCaseStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitCaseStatement(org.codehaus.groovy.ast.stmt.CaseStatement)), [visitCastExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitCastExpression(org.codehaus.groovy.ast.expr.CastExpression)), [visitCatchStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitCatchStatement(org.codehaus.groovy.ast.stmt.CatchStatement)), [visitClassExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitClassExpression(org.codehaus.groovy.ast.expr.ClassExpression)), [visitClosureExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitClosureExpression(org.codehaus.groovy.ast.expr.ClosureExpression)), [visitClosureListExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitClosureListExpression(org.codehaus.groovy.ast.expr.ClosureListExpression)), [visitConstantExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitConstantExpression(org.codehaus.groovy.ast.expr.ConstantExpression)), [visitConstructorCallExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitConstructorCallExpression(org.codehaus.groovy.ast.expr.ConstructorCallExpression)), [visitContinueStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitContinueStatement(org.codehaus.groovy.ast.stmt.ContinueStatement)), [visitDeclarationExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitDeclarationExpression(org.codehaus.groovy.ast.expr.DeclarationExpression)), [visitDoWhileLoop](../../../../../codehaus/groovy/ast/codevisitorsupport#visitDoWhileLoop(org.codehaus.groovy.ast.stmt.DoWhileStatement)), [visitEmptyStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitEmptyStatement(org.codehaus.groovy.ast.stmt.EmptyStatement)), [visitExpressionStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitExpressionStatement(org.codehaus.groovy.ast.stmt.ExpressionStatement)), [visitFieldExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitFieldExpression(org.codehaus.groovy.ast.expr.FieldExpression)), [visitForLoop](../../../../../codehaus/groovy/ast/codevisitorsupport#visitForLoop(org.codehaus.groovy.ast.stmt.ForStatement)), [visitGStringExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitGStringExpression(org.codehaus.groovy.ast.expr.GStringExpression)), [visitIfElse](../../../../../codehaus/groovy/ast/codevisitorsupport#visitIfElse(org.codehaus.groovy.ast.stmt.IfStatement)), [visitLambdaExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitLambdaExpression(org.codehaus.groovy.ast.expr.LambdaExpression)), [visitListExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitListExpression(org.codehaus.groovy.ast.expr.ListExpression)), [visitMapEntryExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitMapEntryExpression(org.codehaus.groovy.ast.expr.MapEntryExpression)), [visitMapExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitMapExpression(org.codehaus.groovy.ast.expr.MapExpression)), [visitMethodCallExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitMethodCallExpression(org.codehaus.groovy.ast.expr.MethodCallExpression)), [visitMethodPointerExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitMethodPointerExpression(org.codehaus.groovy.ast.expr.MethodPointerExpression)), [visitMethodReferenceExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitMethodReferenceExpression(org.codehaus.groovy.ast.expr.MethodReferenceExpression)), [visitNotExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitNotExpression(org.codehaus.groovy.ast.expr.NotExpression)), [visitPostfixExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitPostfixExpression(org.codehaus.groovy.ast.expr.PostfixExpression)), [visitPrefixExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitPrefixExpression(org.codehaus.groovy.ast.expr.PrefixExpression)), [visitPropertyExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitPropertyExpression(org.codehaus.groovy.ast.expr.PropertyExpression)), [visitRangeExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitRangeExpression(org.codehaus.groovy.ast.expr.RangeExpression)), [visitReturnStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitReturnStatement(org.codehaus.groovy.ast.stmt.ReturnStatement)), [visitShortTernaryExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitShortTernaryExpression(org.codehaus.groovy.ast.expr.ElvisOperatorExpression)), [visitSpreadExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitSpreadExpression(org.codehaus.groovy.ast.expr.SpreadExpression)), [visitSpreadMapExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitSpreadMapExpression(org.codehaus.groovy.ast.expr.SpreadMapExpression)), [visitStaticMethodCallExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitStaticMethodCallExpression(org.codehaus.groovy.ast.expr.StaticMethodCallExpression)), [visitSwitch](../../../../../codehaus/groovy/ast/codevisitorsupport#visitSwitch(org.codehaus.groovy.ast.stmt.SwitchStatement)), [visitSynchronizedStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitSynchronizedStatement(org.codehaus.groovy.ast.stmt.SynchronizedStatement)), [visitTernaryExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitTernaryExpression(org.codehaus.groovy.ast.expr.TernaryExpression)), [visitThrowStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitThrowStatement(org.codehaus.groovy.ast.stmt.ThrowStatement)), [visitTryCatchFinally](../../../../../codehaus/groovy/ast/codevisitorsupport#visitTryCatchFinally(org.codehaus.groovy.ast.stmt.TryCatchStatement)), [visitTupleExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitTupleExpression(org.codehaus.groovy.ast.expr.TupleExpression)), [visitUnaryMinusExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitUnaryMinusExpression(org.codehaus.groovy.ast.expr.UnaryMinusExpression)), [visitUnaryPlusExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitUnaryPlusExpression(org.codehaus.groovy.ast.expr.UnaryPlusExpression)), [visitVariableExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitVariableExpression(org.codehaus.groovy.ast.expr.VariableExpression)), [visitWhileLoop](../../../../../codehaus/groovy/ast/codevisitorsupport#visitWhileLoop(org.codehaus.groovy.ast.stmt.WhileStatement))` \| Constructor Detail ------------------ ### GinqAstWalker.10() Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") void visitMethodCallExpression([MethodCallExpression](../../../../../codehaus/groovy/ast/expr/methodcallexpression) call) groovy [Groovy] Class GinqAstWalker.9 [Groovy] Class GinqAstWalker.9 ============================== * org.apache.groovy.ginq.provider.collection.GinqAstWalker.9 ``` class GinqAstWalker.9 extends [GinqAstBaseVisitor](../../dsl/ginqastbasevisitor) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[GinqAstWalker.9](#GinqAstWalker.9())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `void` \| `[visitMethodCallExpression](#visitMethodCallExpression(org.codehaus.groovy.ast.expr.MethodCallExpression))([MethodCallExpression](../../../../../codehaus/groovy/ast/expr/methodcallexpression) call)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [GinqAstBaseVisitor](../../dsl/ginqastbasevisitor)` \| `[visit](../../dsl/ginqastbasevisitor#visit(org.apache.groovy.ginq.dsl.expression.AbstractGinqExpression)), [visitFromExpression](../../dsl/ginqastbasevisitor#visitFromExpression(org.apache.groovy.ginq.dsl.expression.FromExpression)), [visitGinqExpression](../../dsl/ginqastbasevisitor#visitGinqExpression(org.apache.groovy.ginq.dsl.expression.GinqExpression)), [visitGroupExpression](../../dsl/ginqastbasevisitor#visitGroupExpression(org.apache.groovy.ginq.dsl.expression.GroupExpression)), [visitHavingExpression](../../dsl/ginqastbasevisitor#visitHavingExpression(org.apache.groovy.ginq.dsl.expression.HavingExpression)), [visitJoinExpression](../../dsl/ginqastbasevisitor#visitJoinExpression(org.apache.groovy.ginq.dsl.expression.JoinExpression)), [visitLimitExpression](../../dsl/ginqastbasevisitor#visitLimitExpression(org.apache.groovy.ginq.dsl.expression.LimitExpression)), [visitOnExpression](../../dsl/ginqastbasevisitor#visitOnExpression(org.apache.groovy.ginq.dsl.expression.OnExpression)), [visitOrderExpression](../../dsl/ginqastbasevisitor#visitOrderExpression(org.apache.groovy.ginq.dsl.expression.OrderExpression)), [visitSelectExpression](../../dsl/ginqastbasevisitor#visitSelectExpression(org.apache.groovy.ginq.dsl.expression.SelectExpression)), [visitShutdownExpression](../../dsl/ginqastbasevisitor#visitShutdownExpression(org.apache.groovy.ginq.dsl.expression.ShutdownExpression)), [visitWhereExpression](../../dsl/ginqastbasevisitor#visitWhereExpression(org.apache.groovy.ginq.dsl.expression.WhereExpression))` \| \| `class [CodeVisitorSupport](../../../../../codehaus/groovy/ast/codevisitorsupport)` \| `[afterSwitchConditionExpressionVisited](../../../../../codehaus/groovy/ast/codevisitorsupport#afterSwitchConditionExpressionVisited(org.codehaus.groovy.ast.stmt.SwitchStatement)), [visitArgumentlistExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitArgumentlistExpression(org.codehaus.groovy.ast.expr.ArgumentListExpression)), [visitArrayExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitArrayExpression(org.codehaus.groovy.ast.expr.ArrayExpression)), [visitAssertStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitAssertStatement(org.codehaus.groovy.ast.stmt.AssertStatement)), [visitAttributeExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitAttributeExpression(org.codehaus.groovy.ast.expr.AttributeExpression)), [visitBinaryExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBinaryExpression(org.codehaus.groovy.ast.expr.BinaryExpression)), [visitBitwiseNegationExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBitwiseNegationExpression(org.codehaus.groovy.ast.expr.BitwiseNegationExpression)), [visitBlockStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBlockStatement(org.codehaus.groovy.ast.stmt.BlockStatement)), [visitBooleanExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBooleanExpression(org.codehaus.groovy.ast.expr.BooleanExpression)), [visitBreakStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBreakStatement(org.codehaus.groovy.ast.stmt.BreakStatement)), [visitBytecodeExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBytecodeExpression(org.codehaus.groovy.classgen.BytecodeExpression)), [visitCaseStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitCaseStatement(org.codehaus.groovy.ast.stmt.CaseStatement)), [visitCastExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitCastExpression(org.codehaus.groovy.ast.expr.CastExpression)), [visitCatchStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitCatchStatement(org.codehaus.groovy.ast.stmt.CatchStatement)), [visitClassExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitClassExpression(org.codehaus.groovy.ast.expr.ClassExpression)), [visitClosureExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitClosureExpression(org.codehaus.groovy.ast.expr.ClosureExpression)), [visitClosureListExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitClosureListExpression(org.codehaus.groovy.ast.expr.ClosureListExpression)), [visitConstantExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitConstantExpression(org.codehaus.groovy.ast.expr.ConstantExpression)), [visitConstructorCallExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitConstructorCallExpression(org.codehaus.groovy.ast.expr.ConstructorCallExpression)), [visitContinueStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitContinueStatement(org.codehaus.groovy.ast.stmt.ContinueStatement)), [visitDeclarationExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitDeclarationExpression(org.codehaus.groovy.ast.expr.DeclarationExpression)), [visitDoWhileLoop](../../../../../codehaus/groovy/ast/codevisitorsupport#visitDoWhileLoop(org.codehaus.groovy.ast.stmt.DoWhileStatement)), [visitEmptyStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitEmptyStatement(org.codehaus.groovy.ast.stmt.EmptyStatement)), [visitExpressionStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitExpressionStatement(org.codehaus.groovy.ast.stmt.ExpressionStatement)), [visitFieldExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitFieldExpression(org.codehaus.groovy.ast.expr.FieldExpression)), [visitForLoop](../../../../../codehaus/groovy/ast/codevisitorsupport#visitForLoop(org.codehaus.groovy.ast.stmt.ForStatement)), [visitGStringExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitGStringExpression(org.codehaus.groovy.ast.expr.GStringExpression)), [visitIfElse](../../../../../codehaus/groovy/ast/codevisitorsupport#visitIfElse(org.codehaus.groovy.ast.stmt.IfStatement)), [visitLambdaExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitLambdaExpression(org.codehaus.groovy.ast.expr.LambdaExpression)), [visitListExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitListExpression(org.codehaus.groovy.ast.expr.ListExpression)), [visitMapEntryExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitMapEntryExpression(org.codehaus.groovy.ast.expr.MapEntryExpression)), [visitMapExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitMapExpression(org.codehaus.groovy.ast.expr.MapExpression)), [visitMethodCallExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitMethodCallExpression(org.codehaus.groovy.ast.expr.MethodCallExpression)), [visitMethodPointerExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitMethodPointerExpression(org.codehaus.groovy.ast.expr.MethodPointerExpression)), [visitMethodReferenceExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitMethodReferenceExpression(org.codehaus.groovy.ast.expr.MethodReferenceExpression)), [visitNotExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitNotExpression(org.codehaus.groovy.ast.expr.NotExpression)), [visitPostfixExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitPostfixExpression(org.codehaus.groovy.ast.expr.PostfixExpression)), [visitPrefixExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitPrefixExpression(org.codehaus.groovy.ast.expr.PrefixExpression)), [visitPropertyExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitPropertyExpression(org.codehaus.groovy.ast.expr.PropertyExpression)), [visitRangeExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitRangeExpression(org.codehaus.groovy.ast.expr.RangeExpression)), [visitReturnStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitReturnStatement(org.codehaus.groovy.ast.stmt.ReturnStatement)), [visitShortTernaryExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitShortTernaryExpression(org.codehaus.groovy.ast.expr.ElvisOperatorExpression)), [visitSpreadExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitSpreadExpression(org.codehaus.groovy.ast.expr.SpreadExpression)), [visitSpreadMapExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitSpreadMapExpression(org.codehaus.groovy.ast.expr.SpreadMapExpression)), [visitStaticMethodCallExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitStaticMethodCallExpression(org.codehaus.groovy.ast.expr.StaticMethodCallExpression)), [visitSwitch](../../../../../codehaus/groovy/ast/codevisitorsupport#visitSwitch(org.codehaus.groovy.ast.stmt.SwitchStatement)), [visitSynchronizedStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitSynchronizedStatement(org.codehaus.groovy.ast.stmt.SynchronizedStatement)), [visitTernaryExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitTernaryExpression(org.codehaus.groovy.ast.expr.TernaryExpression)), [visitThrowStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitThrowStatement(org.codehaus.groovy.ast.stmt.ThrowStatement)), [visitTryCatchFinally](../../../../../codehaus/groovy/ast/codevisitorsupport#visitTryCatchFinally(org.codehaus.groovy.ast.stmt.TryCatchStatement)), [visitTupleExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitTupleExpression(org.codehaus.groovy.ast.expr.TupleExpression)), [visitUnaryMinusExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitUnaryMinusExpression(org.codehaus.groovy.ast.expr.UnaryMinusExpression)), [visitUnaryPlusExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitUnaryPlusExpression(org.codehaus.groovy.ast.expr.UnaryPlusExpression)), [visitVariableExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitVariableExpression(org.codehaus.groovy.ast.expr.VariableExpression)), [visitWhileLoop](../../../../../codehaus/groovy/ast/codevisitorsupport#visitWhileLoop(org.codehaus.groovy.ast.stmt.WhileStatement))` \| Constructor Detail ------------------ ### GinqAstWalker.9() Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") void visitMethodCallExpression([MethodCallExpression](../../../../../codehaus/groovy/ast/expr/methodcallexpression) call)	programming_docs
groovy [Groovy] Class GinqAstWalker.2 [Groovy] Class GinqAstWalker.2 ============================== * org.apache.groovy.ginq.provider.collection.GinqAstWalker.2 ``` class GinqAstWalker.2 extends [GinqAstBaseVisitor](../../dsl/ginqastbasevisitor) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[GinqAstWalker.2](#GinqAstWalker.2())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `void` \| `[visitListOfExpressions](#visitListOfExpressions(List))([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<? extends Expression> list)` \| \| \| `void` \| `[visitMethodCallExpression](#visitMethodCallExpression(org.codehaus.groovy.ast.expr.MethodCallExpression))([MethodCallExpression](../../../../../codehaus/groovy/ast/expr/methodcallexpression) call)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [GinqAstBaseVisitor](../../dsl/ginqastbasevisitor)` \| `[visit](../../dsl/ginqastbasevisitor#visit(org.apache.groovy.ginq.dsl.expression.AbstractGinqExpression)), [visitFromExpression](../../dsl/ginqastbasevisitor#visitFromExpression(org.apache.groovy.ginq.dsl.expression.FromExpression)), [visitGinqExpression](../../dsl/ginqastbasevisitor#visitGinqExpression(org.apache.groovy.ginq.dsl.expression.GinqExpression)), [visitGroupExpression](../../dsl/ginqastbasevisitor#visitGroupExpression(org.apache.groovy.ginq.dsl.expression.GroupExpression)), [visitHavingExpression](../../dsl/ginqastbasevisitor#visitHavingExpression(org.apache.groovy.ginq.dsl.expression.HavingExpression)), [visitJoinExpression](../../dsl/ginqastbasevisitor#visitJoinExpression(org.apache.groovy.ginq.dsl.expression.JoinExpression)), [visitLimitExpression](../../dsl/ginqastbasevisitor#visitLimitExpression(org.apache.groovy.ginq.dsl.expression.LimitExpression)), [visitOnExpression](../../dsl/ginqastbasevisitor#visitOnExpression(org.apache.groovy.ginq.dsl.expression.OnExpression)), [visitOrderExpression](../../dsl/ginqastbasevisitor#visitOrderExpression(org.apache.groovy.ginq.dsl.expression.OrderExpression)), [visitSelectExpression](../../dsl/ginqastbasevisitor#visitSelectExpression(org.apache.groovy.ginq.dsl.expression.SelectExpression)), [visitShutdownExpression](../../dsl/ginqastbasevisitor#visitShutdownExpression(org.apache.groovy.ginq.dsl.expression.ShutdownExpression)), [visitWhereExpression](../../dsl/ginqastbasevisitor#visitWhereExpression(org.apache.groovy.ginq.dsl.expression.WhereExpression))` \| \| `class [CodeVisitorSupport](../../../../../codehaus/groovy/ast/codevisitorsupport)` \| `[afterSwitchConditionExpressionVisited](../../../../../codehaus/groovy/ast/codevisitorsupport#afterSwitchConditionExpressionVisited(org.codehaus.groovy.ast.stmt.SwitchStatement)), [visitArgumentlistExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitArgumentlistExpression(org.codehaus.groovy.ast.expr.ArgumentListExpression)), [visitArrayExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitArrayExpression(org.codehaus.groovy.ast.expr.ArrayExpression)), [visitAssertStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitAssertStatement(org.codehaus.groovy.ast.stmt.AssertStatement)), [visitAttributeExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitAttributeExpression(org.codehaus.groovy.ast.expr.AttributeExpression)), [visitBinaryExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBinaryExpression(org.codehaus.groovy.ast.expr.BinaryExpression)), [visitBitwiseNegationExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBitwiseNegationExpression(org.codehaus.groovy.ast.expr.BitwiseNegationExpression)), [visitBlockStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBlockStatement(org.codehaus.groovy.ast.stmt.BlockStatement)), [visitBooleanExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBooleanExpression(org.codehaus.groovy.ast.expr.BooleanExpression)), [visitBreakStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBreakStatement(org.codehaus.groovy.ast.stmt.BreakStatement)), [visitBytecodeExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBytecodeExpression(org.codehaus.groovy.classgen.BytecodeExpression)), [visitCaseStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitCaseStatement(org.codehaus.groovy.ast.stmt.CaseStatement)), [visitCastExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitCastExpression(org.codehaus.groovy.ast.expr.CastExpression)), [visitCatchStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitCatchStatement(org.codehaus.groovy.ast.stmt.CatchStatement)), [visitClassExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitClassExpression(org.codehaus.groovy.ast.expr.ClassExpression)), [visitClosureExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitClosureExpression(org.codehaus.groovy.ast.expr.ClosureExpression)), [visitClosureListExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitClosureListExpression(org.codehaus.groovy.ast.expr.ClosureListExpression)), [visitConstantExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitConstantExpression(org.codehaus.groovy.ast.expr.ConstantExpression)), [visitConstructorCallExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitConstructorCallExpression(org.codehaus.groovy.ast.expr.ConstructorCallExpression)), [visitContinueStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitContinueStatement(org.codehaus.groovy.ast.stmt.ContinueStatement)), [visitDeclarationExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitDeclarationExpression(org.codehaus.groovy.ast.expr.DeclarationExpression)), [visitDoWhileLoop](../../../../../codehaus/groovy/ast/codevisitorsupport#visitDoWhileLoop(org.codehaus.groovy.ast.stmt.DoWhileStatement)), [visitEmptyStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitEmptyStatement(org.codehaus.groovy.ast.stmt.EmptyStatement)), [visitExpressionStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitExpressionStatement(org.codehaus.groovy.ast.stmt.ExpressionStatement)), [visitFieldExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitFieldExpression(org.codehaus.groovy.ast.expr.FieldExpression)), [visitForLoop](../../../../../codehaus/groovy/ast/codevisitorsupport#visitForLoop(org.codehaus.groovy.ast.stmt.ForStatement)), [visitGStringExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitGStringExpression(org.codehaus.groovy.ast.expr.GStringExpression)), [visitIfElse](../../../../../codehaus/groovy/ast/codevisitorsupport#visitIfElse(org.codehaus.groovy.ast.stmt.IfStatement)), [visitLambdaExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitLambdaExpression(org.codehaus.groovy.ast.expr.LambdaExpression)), [visitListExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitListExpression(org.codehaus.groovy.ast.expr.ListExpression)), [visitMapEntryExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitMapEntryExpression(org.codehaus.groovy.ast.expr.MapEntryExpression)), [visitMapExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitMapExpression(org.codehaus.groovy.ast.expr.MapExpression)), [visitMethodCallExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitMethodCallExpression(org.codehaus.groovy.ast.expr.MethodCallExpression)), [visitMethodPointerExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitMethodPointerExpression(org.codehaus.groovy.ast.expr.MethodPointerExpression)), [visitMethodReferenceExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitMethodReferenceExpression(org.codehaus.groovy.ast.expr.MethodReferenceExpression)), [visitNotExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitNotExpression(org.codehaus.groovy.ast.expr.NotExpression)), [visitPostfixExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitPostfixExpression(org.codehaus.groovy.ast.expr.PostfixExpression)), [visitPrefixExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitPrefixExpression(org.codehaus.groovy.ast.expr.PrefixExpression)), [visitPropertyExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitPropertyExpression(org.codehaus.groovy.ast.expr.PropertyExpression)), [visitRangeExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitRangeExpression(org.codehaus.groovy.ast.expr.RangeExpression)), [visitReturnStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitReturnStatement(org.codehaus.groovy.ast.stmt.ReturnStatement)), [visitShortTernaryExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitShortTernaryExpression(org.codehaus.groovy.ast.expr.ElvisOperatorExpression)), [visitSpreadExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitSpreadExpression(org.codehaus.groovy.ast.expr.SpreadExpression)), [visitSpreadMapExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitSpreadMapExpression(org.codehaus.groovy.ast.expr.SpreadMapExpression)), [visitStaticMethodCallExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitStaticMethodCallExpression(org.codehaus.groovy.ast.expr.StaticMethodCallExpression)), [visitSwitch](../../../../../codehaus/groovy/ast/codevisitorsupport#visitSwitch(org.codehaus.groovy.ast.stmt.SwitchStatement)), [visitSynchronizedStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitSynchronizedStatement(org.codehaus.groovy.ast.stmt.SynchronizedStatement)), [visitTernaryExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitTernaryExpression(org.codehaus.groovy.ast.expr.TernaryExpression)), [visitThrowStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitThrowStatement(org.codehaus.groovy.ast.stmt.ThrowStatement)), [visitTryCatchFinally](../../../../../codehaus/groovy/ast/codevisitorsupport#visitTryCatchFinally(org.codehaus.groovy.ast.stmt.TryCatchStatement)), [visitTupleExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitTupleExpression(org.codehaus.groovy.ast.expr.TupleExpression)), [visitUnaryMinusExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitUnaryMinusExpression(org.codehaus.groovy.ast.expr.UnaryMinusExpression)), [visitUnaryPlusExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitUnaryPlusExpression(org.codehaus.groovy.ast.expr.UnaryPlusExpression)), [visitVariableExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitVariableExpression(org.codehaus.groovy.ast.expr.VariableExpression)), [visitWhileLoop](../../../../../codehaus/groovy/ast/codevisitorsupport#visitWhileLoop(org.codehaus.groovy.ast.stmt.WhileStatement))` \| Constructor Detail ------------------ ### GinqAstWalker.2() Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") void visitListOfExpressions([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<? extends Expression> list) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") void visitMethodCallExpression([MethodCallExpression](../../../../../codehaus/groovy/ast/expr/methodcallexpression) call) groovy [Groovy] Class GinqAstWalker.7.1 [Groovy] Class GinqAstWalker.7.1 ================================ * org.apache.groovy.ginq.provider.collection.GinqAstWalker.7.1 ``` class GinqAstWalker.7.1 extends [ExpressionTransformer](../../../../../codehaus/groovy/ast/expr/expressiontransformer) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[GinqAstWalker.7.1](#GinqAstWalker.7.1())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[transform](#transform(org.codehaus.groovy.ast.expr.Expression))([Expression](../../../../../codehaus/groovy/ast/expr/expression) expr)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `interface [ExpressionTransformer](../../../../../codehaus/groovy/ast/expr/expressiontransformer)` \| `[transform](../../../../../codehaus/groovy/ast/expr/expressiontransformer#transform(org.codehaus.groovy.ast.expr.Expression))` \| Constructor Detail ------------------ ### GinqAstWalker.7.1() Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") [Expression](../../../../../codehaus/groovy/ast/expr/expression) transform([Expression](../../../../../codehaus/groovy/ast/expr/expression) expr) groovy [Groovy] Class GinqAstWalker.3 [Groovy] Class GinqAstWalker.3 ============================== * org.apache.groovy.ginq.provider.collection.GinqAstWalker.3 ``` class GinqAstWalker.3 extends [CodeVisitorSupport](../../../../../codehaus/groovy/ast/codevisitorsupport) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[GinqAstWalker.3](#GinqAstWalker.3())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `void` \| `[visitBinaryExpression](#visitBinaryExpression(org.codehaus.groovy.ast.expr.BinaryExpression))([BinaryExpression](../../../../../codehaus/groovy/ast/expr/binaryexpression) expression)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [CodeVisitorSupport](../../../../../codehaus/groovy/ast/codevisitorsupport)` \| `[afterSwitchConditionExpressionVisited](../../../../../codehaus/groovy/ast/codevisitorsupport#afterSwitchConditionExpressionVisited(org.codehaus.groovy.ast.stmt.SwitchStatement)), [visitArgumentlistExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitArgumentlistExpression(org.codehaus.groovy.ast.expr.ArgumentListExpression)), [visitArrayExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitArrayExpression(org.codehaus.groovy.ast.expr.ArrayExpression)), [visitAssertStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitAssertStatement(org.codehaus.groovy.ast.stmt.AssertStatement)), [visitAttributeExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitAttributeExpression(org.codehaus.groovy.ast.expr.AttributeExpression)), [visitBinaryExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBinaryExpression(org.codehaus.groovy.ast.expr.BinaryExpression)), [visitBitwiseNegationExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBitwiseNegationExpression(org.codehaus.groovy.ast.expr.BitwiseNegationExpression)), [visitBlockStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBlockStatement(org.codehaus.groovy.ast.stmt.BlockStatement)), [visitBooleanExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBooleanExpression(org.codehaus.groovy.ast.expr.BooleanExpression)), [visitBreakStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBreakStatement(org.codehaus.groovy.ast.stmt.BreakStatement)), [visitBytecodeExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitBytecodeExpression(org.codehaus.groovy.classgen.BytecodeExpression)), [visitCaseStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitCaseStatement(org.codehaus.groovy.ast.stmt.CaseStatement)), [visitCastExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitCastExpression(org.codehaus.groovy.ast.expr.CastExpression)), [visitCatchStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitCatchStatement(org.codehaus.groovy.ast.stmt.CatchStatement)), [visitClassExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitClassExpression(org.codehaus.groovy.ast.expr.ClassExpression)), [visitClosureExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitClosureExpression(org.codehaus.groovy.ast.expr.ClosureExpression)), [visitClosureListExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitClosureListExpression(org.codehaus.groovy.ast.expr.ClosureListExpression)), [visitConstantExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitConstantExpression(org.codehaus.groovy.ast.expr.ConstantExpression)), [visitConstructorCallExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitConstructorCallExpression(org.codehaus.groovy.ast.expr.ConstructorCallExpression)), [visitContinueStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitContinueStatement(org.codehaus.groovy.ast.stmt.ContinueStatement)), [visitDeclarationExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitDeclarationExpression(org.codehaus.groovy.ast.expr.DeclarationExpression)), [visitDoWhileLoop](../../../../../codehaus/groovy/ast/codevisitorsupport#visitDoWhileLoop(org.codehaus.groovy.ast.stmt.DoWhileStatement)), [visitEmptyStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitEmptyStatement(org.codehaus.groovy.ast.stmt.EmptyStatement)), [visitExpressionStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitExpressionStatement(org.codehaus.groovy.ast.stmt.ExpressionStatement)), [visitFieldExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitFieldExpression(org.codehaus.groovy.ast.expr.FieldExpression)), [visitForLoop](../../../../../codehaus/groovy/ast/codevisitorsupport#visitForLoop(org.codehaus.groovy.ast.stmt.ForStatement)), [visitGStringExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitGStringExpression(org.codehaus.groovy.ast.expr.GStringExpression)), [visitIfElse](../../../../../codehaus/groovy/ast/codevisitorsupport#visitIfElse(org.codehaus.groovy.ast.stmt.IfStatement)), [visitLambdaExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitLambdaExpression(org.codehaus.groovy.ast.expr.LambdaExpression)), [visitListExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitListExpression(org.codehaus.groovy.ast.expr.ListExpression)), [visitMapEntryExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitMapEntryExpression(org.codehaus.groovy.ast.expr.MapEntryExpression)), [visitMapExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitMapExpression(org.codehaus.groovy.ast.expr.MapExpression)), [visitMethodCallExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitMethodCallExpression(org.codehaus.groovy.ast.expr.MethodCallExpression)), [visitMethodPointerExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitMethodPointerExpression(org.codehaus.groovy.ast.expr.MethodPointerExpression)), [visitMethodReferenceExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitMethodReferenceExpression(org.codehaus.groovy.ast.expr.MethodReferenceExpression)), [visitNotExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitNotExpression(org.codehaus.groovy.ast.expr.NotExpression)), [visitPostfixExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitPostfixExpression(org.codehaus.groovy.ast.expr.PostfixExpression)), [visitPrefixExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitPrefixExpression(org.codehaus.groovy.ast.expr.PrefixExpression)), [visitPropertyExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitPropertyExpression(org.codehaus.groovy.ast.expr.PropertyExpression)), [visitRangeExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitRangeExpression(org.codehaus.groovy.ast.expr.RangeExpression)), [visitReturnStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitReturnStatement(org.codehaus.groovy.ast.stmt.ReturnStatement)), [visitShortTernaryExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitShortTernaryExpression(org.codehaus.groovy.ast.expr.ElvisOperatorExpression)), [visitSpreadExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitSpreadExpression(org.codehaus.groovy.ast.expr.SpreadExpression)), [visitSpreadMapExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitSpreadMapExpression(org.codehaus.groovy.ast.expr.SpreadMapExpression)), [visitStaticMethodCallExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitStaticMethodCallExpression(org.codehaus.groovy.ast.expr.StaticMethodCallExpression)), [visitSwitch](../../../../../codehaus/groovy/ast/codevisitorsupport#visitSwitch(org.codehaus.groovy.ast.stmt.SwitchStatement)), [visitSynchronizedStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitSynchronizedStatement(org.codehaus.groovy.ast.stmt.SynchronizedStatement)), [visitTernaryExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitTernaryExpression(org.codehaus.groovy.ast.expr.TernaryExpression)), [visitThrowStatement](../../../../../codehaus/groovy/ast/codevisitorsupport#visitThrowStatement(org.codehaus.groovy.ast.stmt.ThrowStatement)), [visitTryCatchFinally](../../../../../codehaus/groovy/ast/codevisitorsupport#visitTryCatchFinally(org.codehaus.groovy.ast.stmt.TryCatchStatement)), [visitTupleExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitTupleExpression(org.codehaus.groovy.ast.expr.TupleExpression)), [visitUnaryMinusExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitUnaryMinusExpression(org.codehaus.groovy.ast.expr.UnaryMinusExpression)), [visitUnaryPlusExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitUnaryPlusExpression(org.codehaus.groovy.ast.expr.UnaryPlusExpression)), [visitVariableExpression](../../../../../codehaus/groovy/ast/codevisitorsupport#visitVariableExpression(org.codehaus.groovy.ast.expr.VariableExpression)), [visitWhileLoop](../../../../../codehaus/groovy/ast/codevisitorsupport#visitWhileLoop(org.codehaus.groovy.ast.stmt.WhileStatement))` \| Constructor Detail ------------------ ### GinqAstWalker.3() Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") void visitBinaryExpression([BinaryExpression](../../../../../codehaus/groovy/ast/expr/binaryexpression) expression)	programming_docs
groovy [Java] Class RowBound [Java] Class RowBound ===================== * org.apache.groovy.ginq.provider.collection.runtime.RowBound ``` public class RowBound extends [AbstractBound](abstractbound) ``` Represents row bounds of window frame Since: 4.0.0 Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `static [RowBound](rowbound)` \| `[DEFAULT](#DEFAULT)` \| \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[RowBound](#RowBound(java.lang.Long,%20java.lang.Long))([Long](https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html "Long") lower, [Long](https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html "Long") upper)`Construct a new RowBound instance with lower and upper frame bounds \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractBound](abstractbound)` \| `[getLower](abstractbound#getLower()), [getUpper](abstractbound#getUpper())` \| Field Detail ------------ ### public static final [RowBound](rowbound) DEFAULT Constructor Detail ------------------ ### public RowBound([Long](https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html "Long") lower, [Long](https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html "Long") upper) Construct a new RowBound instance with lower and upper frame bounds Parameters: `lower` - the lower frame bound `upper` - the upper frame bound Since: 4.0.0 groovy [Java] Class TooManyValuesException [Java] Class TooManyValuesException =================================== * org.apache.groovy.ginq.provider.collection.runtime.TooManyValuesException ``` public class TooManyValuesException extends [GroovyRuntimeException](../../../../../../../groovy/lang/groovyruntimeexception) ``` Thrown when too many values returned by sub-query in the `select` clause Since: 4.0.0 Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[TooManyValuesException](#TooManyValuesException(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") msg)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [GroovyRuntimeException](../../../../../../../groovy/lang/groovyruntimeexception)` \| `[getLocationText](../../../../../../../groovy/lang/groovyruntimeexception#getLocationText()), [getMessage](../../../../../../../groovy/lang/groovyruntimeexception#getMessage()), [getMessageWithoutLocationText](../../../../../../../groovy/lang/groovyruntimeexception#getMessageWithoutLocationText()), [getModule](../../../../../../../groovy/lang/groovyruntimeexception#getModule()), [getNode](../../../../../../../groovy/lang/groovyruntimeexception#getNode()), [setModule](../../../../../../../groovy/lang/groovyruntimeexception#setModule(org.codehaus.groovy.ast.ModuleNode))` \| Constructor Detail ------------------ ### public TooManyValuesException([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") msg) groovy [Java] Class ValueBound<U extends Comparable<? super U>> [Java] Class ValueBound<U extends Comparable<? super U>> ======================================================== * org.apache.groovy.ginq.provider.collection.runtime.ValueBound ``` public class ValueBound<U extends Comparable<? super U>> extends [AbstractBound](abstractbound) ``` Represents value bounds of window frame Since: 4.0.0 Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[ValueBound](#ValueBound(U,%20U))(U lower, U upper)`Construct a new ValueBound instance with lower and upper frame bounds \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractBound](abstractbound)` \| `[getLower](abstractbound#getLower()), [getUpper](abstractbound#getUpper())` \| Constructor Detail ------------------ ### public ValueBound(U lower, U upper) Construct a new ValueBound instance with lower and upper frame bounds Parameters: `lower` - the lower frame bound `upper` - the upper frame bound Since: 4.0.0 groovy [Java] Interface Window<T> [Java] Interface Window<T> ========================== * org.apache.groovy.ginq.provider.collection.runtime.Queryable All Superinterfaces: [Queryable](queryable) ``` public interface Window<T> extends [Queryable](queryable) ``` Represents window which stores elements used by window functions Type Parameters: `T` - the type of [Window](window "Window") element Since: 4.0.0 Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [BigDecimal](https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html "BigDecimal")` \| `[cumeDist](#cumeDist())()`Returns the cumulative distribution of a value in the window \| \| \| `public [Long](https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html "Long")` \| `[denseRank](#denseRank())()`Returns the dense rank in the window \| \| `<V>` \| `public V` \| `[firstValue](#firstValue(Function))([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ? extends V> extractor)`Returns the first value in the window \| \| `<V>` \| `public V` \| `[lag](#lag(Function))([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ? extends V> extractor)`Returns the previous value in the window, similar to SQL's `lag()` \| \| `<V>` \| `public V` \| `[lag](#lag(Function,%20long))([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ? extends V> extractor, long lag)`Returns the previous value in the window, similar to SQL's `lag()` \| \| `<V>` \| `public V` \| `[lag](#lag(Function,%20long,%20V))([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ? extends V> extractor, long lag, V def)`Returns the previous value by `lag` in the window, similar to SQL's `lag()` \| \| `<V>` \| `public V` \| `[lastValue](#lastValue(Function))([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ? extends V> extractor)`Returns the last value in the window \| \| `<V>` \| `public V` \| `[lead](#lead(Function))([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ? extends V> extractor)`Returns the next value in the window, similar to SQL's `lead()` \| \| `<V>` \| `public V` \| `[lead](#lead(Function,%20long))([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ? extends V> extractor, long lead)`Returns the next value in the window, similar to SQL's `lead()` \| \| `<V>` \| `public V` \| `[lead](#lead(Function,%20long,%20V))([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ? extends V> extractor, long lead, V def)`Returns the next value by `lead` in the window, similar to SQL's `lead()` \| \| `<V>` \| `public V` \| `[nthValue](#nthValue(Function,%20long))([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ? extends V> extractor, long index)`Returns the nth value in the window \| \| \| `public long` \| `[ntile](#ntile(long))(long bucketCnt)`Distributes rows of an ordered window into a pre-defined number of roughly equal buckets \| \| `<T, U extends Comparable<? super U>>` \| `public static [Window](window "Window")<T>` \| `[of](#of(Tuple2,%20Partition,%20WindowDefinition))([Tuple2](../../../../../../../groovy/lang/tuple2 "Tuple2")<T, [Long](https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html "Long")> currentRecord, [Partition](partition "Partition")<[Tuple2](../../../../../../../groovy/lang/tuple2 "Tuple2")<T, [Long](https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html "Long")>> partition, [WindowDefinition](windowdefinition "WindowDefinition")<T, U> windowDefinition)`Factory method to create [Window](window "Window") instance \| \| \| `public [BigDecimal](https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html "BigDecimal")` \| `[percentRank](#percentRank())()`Returns the percent rank in the window \| \| \| `public [Long](https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html "Long")` \| `[rank](#rank())()`Returns the rank in the window \| \| \| `public long` \| `[rowNumber](#rowNumber())()`Returns row number in the window, similar to SQL's `row_number()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `interface [Queryable](queryable)` \| `[agg](queryable#agg(Function)), [avg](queryable#avg(Function)), [count](queryable#count()), [count](queryable#count(Function)), [crossJoin](queryable#crossJoin(Queryable)), [distinct](queryable#distinct()), [emptyQueryable](queryable#emptyQueryable()), [exists](queryable#exists()), [from](queryable#from(Iterable)), [from](queryable#from(T)), [from](queryable#from(Stream)), [from](queryable#from(Queryable)), [fullHashJoin](queryable#fullHashJoin(Queryable,%20Function,%20Function)), [fullJoin](queryable#fullJoin(Queryable,%20BiPredicate)), [groupBy](queryable#groupBy(Function,%20Predicate)), [groupBy](queryable#groupBy(Function)), [innerHashJoin](queryable#innerHashJoin(Queryable,%20Function,%20Function)), [innerJoin](queryable#innerJoin(Queryable,%20BiPredicate)), [intersect](queryable#intersect(Queryable)), [leftHashJoin](queryable#leftHashJoin(Queryable,%20Function,%20Function)), [leftJoin](queryable#leftJoin(Queryable,%20BiPredicate)), [limit](queryable#limit(long,%20long)), [limit](queryable#limit(long)), [max](queryable#max(Function)), [median](queryable#median(Function)), [min](queryable#min(Function)), [minus](queryable#minus(Queryable)), [orderBy](queryable#orderBy(Order)), [orderBy](queryable#orderBy(List)), [over](queryable#over(Tuple2,%20WindowDefinition)), [rightHashJoin](queryable#rightHashJoin(Queryable,%20Function,%20Function)), [rightJoin](queryable#rightJoin(Queryable,%20BiPredicate)), [select](queryable#select(BiFunction)), [size](queryable#size()), [stdev](queryable#stdev(Function)), [stdevp](queryable#stdevp(Function)), [stream](queryable#stream()), [sum](queryable#sum(Function)), [toList](queryable#toList()), [union](queryable#union(Queryable)), [unionAll](queryable#unionAll(Queryable)), [var](queryable#var(Function)), [varp](queryable#varp(Function)), [where](queryable#where(Predicate))` \| Method Detail ------------- ### public [BigDecimal](https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html "BigDecimal") cumeDist() Returns the cumulative distribution of a value in the window Returns: the cumulative distribution of a value Since: 4.0.0 ### public [Long](https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html "Long") denseRank() Returns the dense rank in the window Returns: the dense rank Since: 4.0.0 ### <V> public V firstValue([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ? extends V> extractor) Returns the first value in the window Type Parameters: `V` - the type of field Parameters: `extractor` - field extractor Returns: the first value Since: 4.0.0 ### <V> public V lag([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ? extends V> extractor) Returns the previous value in the window, similar to SQL's `lag()` Parameters: `extractor` - field extractor Type Parameters: `V` - the type of field Returns: the previous value Since: 4.0.0 ### <V> public V lag([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ? extends V> extractor, long lag) Returns the previous value in the window, similar to SQL's `lag()` Parameters: `extractor` - field extractor `lag` - the offset Type Parameters: `V` - the type of field Returns: the previous value Since: 4.0.0 ### <V> public V lag([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ? extends V> extractor, long lag, V def) Returns the previous value by `lag` in the window, similar to SQL's `lag()` Type Parameters: `V` - the type of field Parameters: `extractor` - field extractor `lag` - the offset `def` - the default value Returns: the previous value by `lag` Since: 4.0.0 ### <V> public V lastValue([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ? extends V> extractor) Returns the last value in the window Type Parameters: `V` - the type of field Parameters: `extractor` - field extractor Returns: the last value Since: 4.0.0 ### <V> public V lead([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ? extends V> extractor) Returns the next value in the window, similar to SQL's `lead()` Parameters: `extractor` - field extractor Type Parameters: `V` - the type of field Returns: the next value Since: 4.0.0 ### <V> public V lead([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ? extends V> extractor, long lead) Returns the next value in the window, similar to SQL's `lead()` Parameters: `extractor` - field extractor `lead` - the offset Type Parameters: `V` - the type of field Returns: the next value Since: 4.0.0 ### <V> public V lead([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ? extends V> extractor, long lead, V def) Returns the next value by `lead` in the window, similar to SQL's `lead()` Type Parameters: `V` - the type of field Parameters: `extractor` - field extractor `lead` - the offset `def` - the default value Returns: the next value by `lead` Since: 4.0.0 ### <V> public V nthValue([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ? extends V> extractor, long index) Returns the nth value in the window Type Parameters: `V` - the type of field Parameters: `extractor` - field extractor `index` - index for value to fetch, starting with `0` Returns: the nth value Since: 4.0.0 ### public long ntile(long bucketCnt) Distributes rows of an ordered window into a pre-defined number of roughly equal buckets Parameters: `bucketCnt` - bucket count Returns: bucket index starting with `0` Since: 4.0.0 ### <T, U extends Comparable<? super U>> public static [Window](window "Window")<T> of([Tuple2](../../../../../../../groovy/lang/tuple2 "Tuple2")<T, [Long](https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html "Long")> currentRecord, [Partition](partition "Partition")<[Tuple2](../../../../../../../groovy/lang/tuple2 "Tuple2")<T, [Long](https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html "Long")>> partition, [WindowDefinition](windowdefinition "WindowDefinition")<T, U> windowDefinition) Factory method to create [Window](window "Window") instance Parameters: `currentRecord` - current record `partition` - the partition where the window is constructed `windowDefinition` - window definition Type Parameters: `T` - the type of [Window](window "Window") element `U` - the type of field to sort Returns: the [Window](window "Window") instance Since: 4.0.0 ### public [BigDecimal](https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html "BigDecimal") percentRank() Returns the percent rank in the window Returns: the percent rank Since: 4.0.0 ### public [Long](https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html "Long") rank() Returns the rank in the window Returns: the rank Since: 4.0.0 ### public long rowNumber() Returns row number in the window, similar to SQL's `row_number()` Returns: the row number Since: 4.0.0 groovy [Java] Interface Group<T> [Java] Interface Group<T> ========================= * org.apache.groovy.ginq.provider.collection.runtime.Queryable All Superinterfaces: [Queryable](queryable) ``` public interface Group<T> extends [Queryable](queryable) ``` Represents group Type Parameters: `T` - the type of element Since: 4.0.0 Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| `<T>` \| `public static [Group](group "Group")<T>` \| `[of](#of(Stream))([Stream](https://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html "Stream")<T> sourceStream)`Factory method to create [Group](group "Group") instance \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `interface [Queryable](queryable)` \| `[agg](queryable#agg(Function)), [avg](queryable#avg(Function)), [count](queryable#count()), [count](queryable#count(Function)), [crossJoin](queryable#crossJoin(Queryable)), [distinct](queryable#distinct()), [emptyQueryable](queryable#emptyQueryable()), [exists](queryable#exists()), [from](queryable#from(Iterable)), [from](queryable#from(T)), [from](queryable#from(Stream)), [from](queryable#from(Queryable)), [fullHashJoin](queryable#fullHashJoin(Queryable,%20Function,%20Function)), [fullJoin](queryable#fullJoin(Queryable,%20BiPredicate)), [groupBy](queryable#groupBy(Function,%20Predicate)), [groupBy](queryable#groupBy(Function)), [innerHashJoin](queryable#innerHashJoin(Queryable,%20Function,%20Function)), [innerJoin](queryable#innerJoin(Queryable,%20BiPredicate)), [intersect](queryable#intersect(Queryable)), [leftHashJoin](queryable#leftHashJoin(Queryable,%20Function,%20Function)), [leftJoin](queryable#leftJoin(Queryable,%20BiPredicate)), [limit](queryable#limit(long,%20long)), [limit](queryable#limit(long)), [max](queryable#max(Function)), [median](queryable#median(Function)), [min](queryable#min(Function)), [minus](queryable#minus(Queryable)), [orderBy](queryable#orderBy(Order)), [orderBy](queryable#orderBy(List)), [over](queryable#over(Tuple2,%20WindowDefinition)), [rightHashJoin](queryable#rightHashJoin(Queryable,%20Function,%20Function)), [rightJoin](queryable#rightJoin(Queryable,%20BiPredicate)), [select](queryable#select(BiFunction)), [size](queryable#size()), [stdev](queryable#stdev(Function)), [stdevp](queryable#stdevp(Function)), [stream](queryable#stream()), [sum](queryable#sum(Function)), [toList](queryable#toList()), [union](queryable#union(Queryable)), [unionAll](queryable#unionAll(Queryable)), [var](queryable#var(Function)), [varp](queryable#varp(Function)), [where](queryable#where(Predicate))` \| Method Detail ------------- ### <T> public static [Group](group "Group")<T> of([Stream](https://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html "Stream")<T> sourceStream) Factory method to create [Group](group "Group") instance Parameters: `sourceStream` - the source stream Type Parameters: `T` - the type of element Returns: the [Group](group "Group") instance Since: 4.0.0 groovy [Java] Class Queryable.Order<T, U extends Comparable<? super U>> [Java] Class Queryable.Order<T, U extends Comparable<? super U>> ================================================================ * org.apache.groovy.ginq.provider.collection.runtime.Queryable.Order ``` public class Queryable.Order<T, U extends Comparable<? super U>> ``` Represents an order rule Type Parameters: `T` - the type of element from [Queryable](queryable "Queryable") instance `U` - the type of field to sort Since: 4.0.0 Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `static [Order](../../../../../../../order)[]` \| `[EMPTY\_ARRAY](#EMPTY_ARRAY)` \| \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[Order](#Order(Function,%20boolean))([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ? extends U> keyExtractor, boolean asc)` \| \| `[Order](#Order(Function,%20boolean,%20boolean))([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ? extends U> keyExtractor, boolean asc, boolean nullsLast)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public boolean` \| `[equals](#equals(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o)` \| \| \| `public [Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ? extends U>` \| `[getKeyExtractor](#getKeyExtractor())()` \| \| \| `public int` \| `[hashCode](#hashCode())()` \| \| \| `public boolean` \| `[isAsc](#isAsc())()` \| \| \| `public boolean` \| `[isNullsLast](#isNullsLast())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Field Detail ------------ ### public static final [Order](../../../../../../../order)[] EMPTY\_ARRAY Constructor Detail ------------------ ### public Order([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ? extends U> keyExtractor, boolean asc) ### public Order([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ? extends U> keyExtractor, boolean asc, boolean nullsLast) Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean equals([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o) ### public [Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ? extends U> getKeyExtractor() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public int hashCode() ### public boolean isAsc() ### public boolean isNullsLast()	programming_docs
groovy [Java] Interface Partition<T> [Java] Interface Partition<T> ============================= * org.apache.groovy.ginq.provider.collection.runtime.Queryable All Superinterfaces: [Queryable](queryable) ``` public interface Partition<T> extends [Queryable](queryable) ``` Represents partition Type Parameters: `T` - the type of element Since: 4.0.0 Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| `<T>` \| `public static [Partition](partition "Partition")<T>` \| `[emptyPartition](#emptyPartition())()`Returns the empty Partition instance \| \| `<T>` \| `public static [Partition](partition "Partition")<[Tuple2](../../../../../../../groovy/lang/tuple2 "Tuple2")<T, [Long](https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html "Long")>>` \| `[of](#of(List))([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Tuple2](../../../../../../../groovy/lang/tuple2 "Tuple2")<T, [Long](https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html "Long")>> listWithIndex)`Factory method to create [Partition](partition "Partition") instance \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `interface [Queryable](queryable)` \| `[agg](queryable#agg(Function)), [avg](queryable#avg(Function)), [count](queryable#count()), [count](queryable#count(Function)), [crossJoin](queryable#crossJoin(Queryable)), [distinct](queryable#distinct()), [emptyQueryable](queryable#emptyQueryable()), [exists](queryable#exists()), [from](queryable#from(Iterable)), [from](queryable#from(T)), [from](queryable#from(Stream)), [from](queryable#from(Queryable)), [fullHashJoin](queryable#fullHashJoin(Queryable,%20Function,%20Function)), [fullJoin](queryable#fullJoin(Queryable,%20BiPredicate)), [groupBy](queryable#groupBy(Function,%20Predicate)), [groupBy](queryable#groupBy(Function)), [innerHashJoin](queryable#innerHashJoin(Queryable,%20Function,%20Function)), [innerJoin](queryable#innerJoin(Queryable,%20BiPredicate)), [intersect](queryable#intersect(Queryable)), [leftHashJoin](queryable#leftHashJoin(Queryable,%20Function,%20Function)), [leftJoin](queryable#leftJoin(Queryable,%20BiPredicate)), [limit](queryable#limit(long,%20long)), [limit](queryable#limit(long)), [max](queryable#max(Function)), [median](queryable#median(Function)), [min](queryable#min(Function)), [minus](queryable#minus(Queryable)), [orderBy](queryable#orderBy(Order)), [orderBy](queryable#orderBy(List)), [over](queryable#over(Tuple2,%20WindowDefinition)), [rightHashJoin](queryable#rightHashJoin(Queryable,%20Function,%20Function)), [rightJoin](queryable#rightJoin(Queryable,%20BiPredicate)), [select](queryable#select(BiFunction)), [size](queryable#size()), [stdev](queryable#stdev(Function)), [stdevp](queryable#stdevp(Function)), [stream](queryable#stream()), [sum](queryable#sum(Function)), [toList](queryable#toList()), [union](queryable#union(Queryable)), [unionAll](queryable#unionAll(Queryable)), [var](queryable#var(Function)), [varp](queryable#varp(Function)), [where](queryable#where(Predicate))` \| Method Detail ------------- ### <T> public static [Partition](partition "Partition")<T> emptyPartition() Returns the empty Partition instance Type Parameters: `T` - the type of element Returns: the empty Partition instance Since: 4.0.0 ### <T> public static [Partition](partition "Partition")<[Tuple2](../../../../../../../groovy/lang/tuple2 "Tuple2")<T, [Long](https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html "Long")>> of([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Tuple2](../../../../../../../groovy/lang/tuple2 "Tuple2")<T, [Long](https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html "Long")>> listWithIndex) Factory method to create [Partition](partition "Partition") instance Parameters: `listWithIndex` - the list with index Type Parameters: `T` - the type of element Returns: the [Partition](partition "Partition") instance Since: 4.0.0 groovy [Java] Interface WindowDefinition<T, U extends Comparable<? super U>> [Java] Interface WindowDefinition<T, U extends Comparable<? super U>> ===================================================================== ``` public interface WindowDefinition<T, U extends Comparable<? super U>> ``` Represents window definition, which will define the result set to construct the window Type Parameters: `T` - the type of [Window](window "Window") element `U` - the type of field to sort Since: 4.0.0 Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getId](#getId())()`Get the id of window definition \| \| `<T, U extends Comparable<? super U>>` \| `public static [WindowDefinition](windowdefinition "WindowDefinition")<T, U>` \| `[of](#of())()`Factory method to create [WindowDefinition](windowdefinition "WindowDefinition") instance \| \| `<T, U extends Comparable<? super U>>` \| `public static [WindowDefinition](windowdefinition "WindowDefinition")<T, U>` \| `[of](#of(Function))([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ?> partitionBy)`Factory method to create [WindowDefinition](windowdefinition "WindowDefinition") instance \| \| `<T, U extends Comparable<? super U>>` \| `public static [WindowDefinition](windowdefinition "WindowDefinition")<T, U>` \| `[of](#of(org.apache.groovy.ginq.provider.collection.runtime.Queryable.Order))(org.apache.groovy.ginq.provider.collection.runtime.Queryable.Order<? super T, ? extends U> orderBy)`Factory method to create [WindowDefinition](windowdefinition "WindowDefinition") instance \| \| `<T, U extends Comparable<? super U>>` \| `public static [WindowDefinition](windowdefinition "WindowDefinition")<T, U>` \| `[of](#of(List))([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<Queryable.Order<? super T, ? extends U>> orderBy)`Factory method to create [WindowDefinition](windowdefinition "WindowDefinition") instance \| \| `<T, U extends Comparable<? super U>>` \| `public static [WindowDefinition](windowdefinition "WindowDefinition")<T, U>` \| `[of](#of(Function,%20List))([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ?> partitionBy, [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<Queryable.Order<? super T, ? extends U>> orderBy)`Factory method to create [WindowDefinition](windowdefinition "WindowDefinition") instance \| \| `<T, U extends Comparable<? super U>>` \| `public static [WindowDefinition](windowdefinition "WindowDefinition")<T, U>` \| `[of](#of(Function,%20List,%20org.apache.groovy.ginq.provider.collection.runtime.RowBound))([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ?> partitionBy, [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<Queryable.Order<? super T, ? extends U>> orderBy, [RowBound](rowbound) rows)`Factory method to create [WindowDefinition](windowdefinition "WindowDefinition") instance \| \| `<T, U extends Comparable<? super U>>` \| `public static [WindowDefinition](windowdefinition "WindowDefinition")<T, U>` \| `[of](#of(List,%20org.apache.groovy.ginq.provider.collection.runtime.RowBound))([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<Queryable.Order<? super T, ? extends U>> orderBy, [RowBound](rowbound) rows)`Factory method to create [WindowDefinition](windowdefinition "WindowDefinition") instance \| \| `<T, U extends Comparable<? super U>>` \| `public static [WindowDefinition](windowdefinition "WindowDefinition")<T, U>` \| `[of](#of(Function,%20List,%20ValueBound))([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ?> partitionBy, [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<Queryable.Order<? super T, ? extends U>> orderBy, [ValueBound](valuebound "ValueBound")<? extends U> range)`Factory method to create [WindowDefinition](windowdefinition "WindowDefinition") instance \| \| `<T, U extends Comparable<? super U>>` \| `public static [WindowDefinition](windowdefinition "WindowDefinition")<T, U>` \| `[of](#of(List,%20ValueBound))([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<Queryable.Order<? super T, ? extends U>> orderBy, [ValueBound](valuebound "ValueBound")<? extends U> range)`Factory method to create [WindowDefinition](windowdefinition "WindowDefinition") instance \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<Queryable.Order<? super T, ? extends U>>` \| `[orderBy](#orderBy())()`Define order, similar to SQL's `order by` of window definition \| \| \| `public [Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ?>` \| `[partitionBy](#partitionBy())()`Define partition, similar to SQL's `partition by` of window definition \| \| \| `public [ValueBound](valuebound "ValueBound")<? extends U>` \| `[range](#range())()`Define the window bounds by values, similar to MySQL's `range between 1.0 preceding and 1.0 following` of window definition \| \| \| `public [RowBound](rowbound)` \| `[rows](#rows())()`Define the window bounds by offsets, similar to MySQL's `rows between 1 preceding and 1 following` of window definition \| \| \| `public [WindowDefinition](windowdefinition "WindowDefinition")<T, U>` \| `[setId](#setId(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") id)`Set the id of window definition \| Method Detail ------------- ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getId() Get the id of window definition Returns: the id of window definition Since: 4.0.0 ### <T, U extends Comparable<? super U>> public static [WindowDefinition](windowdefinition "WindowDefinition")<T, U> of() Factory method to create [WindowDefinition](windowdefinition "WindowDefinition") instance Type Parameters: `T` - the type of [Queryable](queryable "Queryable") element `U` - the type of field to sort Returns: the [WindowDefinition](windowdefinition "WindowDefinition") instance Since: 4.0.0 ### <T, U extends Comparable<? super U>> public static [WindowDefinition](windowdefinition "WindowDefinition")<T, U> of([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ?> partitionBy) Factory method to create [WindowDefinition](windowdefinition "WindowDefinition") instance Parameters: `partitionBy` - partition definition Type Parameters: `T` - the type of [Queryable](queryable "Queryable") element `U` - the type of field to sort Returns: the [WindowDefinition](windowdefinition "WindowDefinition") instance Since: 4.0.0 ### <T, U extends Comparable<? super U>> public static [WindowDefinition](windowdefinition "WindowDefinition")<T, U> of(org.apache.groovy.ginq.provider.collection.runtime.Queryable.Order<? super T, ? extends U> orderBy) Factory method to create [WindowDefinition](windowdefinition "WindowDefinition") instance Parameters: `orderBy` - order definition Type Parameters: `T` - the type of [Queryable](queryable "Queryable") element `U` - the type of field to sort Returns: the [WindowDefinition](windowdefinition "WindowDefinition") instance Since: 4.0.0 ### <T, U extends Comparable<? super U>> public static [WindowDefinition](windowdefinition "WindowDefinition")<T, U> of([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<Queryable.Order<? super T, ? extends U>> orderBy) Factory method to create [WindowDefinition](windowdefinition "WindowDefinition") instance Parameters: `orderBy` - order definition Type Parameters: `T` - the type of [Queryable](queryable "Queryable") element `U` - the type of field to sort Returns: the [WindowDefinition](windowdefinition "WindowDefinition") instance Since: 4.0.0 ### <T, U extends Comparable<? super U>> public static [WindowDefinition](windowdefinition "WindowDefinition")<T, U> of([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ?> partitionBy, [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<Queryable.Order<? super T, ? extends U>> orderBy) Factory method to create [WindowDefinition](windowdefinition "WindowDefinition") instance Parameters: `partitionBy` - partition definition `orderBy` - order definition Type Parameters: `T` - the type of [Queryable](queryable "Queryable") element `U` - the type of field to sort Returns: the [WindowDefinition](windowdefinition "WindowDefinition") instance Since: 4.0.0 ### <T, U extends Comparable<? super U>> public static [WindowDefinition](windowdefinition "WindowDefinition")<T, U> of([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ?> partitionBy, [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<Queryable.Order<? super T, ? extends U>> orderBy, [RowBound](rowbound) rows) Factory method to create [WindowDefinition](windowdefinition "WindowDefinition") instance Parameters: `partitionBy` - partition definition `orderBy` - order definition `rows` - the window bounds Type Parameters: `T` - the type of [Queryable](queryable "Queryable") element `U` - the type of field to sort Returns: the [WindowDefinition](windowdefinition "WindowDefinition") instance Since: 4.0.0 ### <T, U extends Comparable<? super U>> public static [WindowDefinition](windowdefinition "WindowDefinition")<T, U> of([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<Queryable.Order<? super T, ? extends U>> orderBy, [RowBound](rowbound) rows) Factory method to create [WindowDefinition](windowdefinition "WindowDefinition") instance Parameters: `orderBy` - order definition `rows` - the window bounds Type Parameters: `T` - the type of [Queryable](queryable "Queryable") element `U` - the type of field to sort Returns: the [WindowDefinition](windowdefinition "WindowDefinition") instance Since: 4.0.0 ### <T, U extends Comparable<? super U>> public static [WindowDefinition](windowdefinition "WindowDefinition")<T, U> of([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ?> partitionBy, [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<Queryable.Order<? super T, ? extends U>> orderBy, [ValueBound](valuebound "ValueBound")<? extends U> range) Factory method to create [WindowDefinition](windowdefinition "WindowDefinition") instance Parameters: `partitionBy` - partition definition `orderBy` - order definition `range` - the window bounds Type Parameters: `T` - the type of [Queryable](queryable "Queryable") element `U` - the type of field to sort Returns: the [WindowDefinition](windowdefinition "WindowDefinition") instance Since: 4.0.0 ### <T, U extends Comparable<? super U>> public static [WindowDefinition](windowdefinition "WindowDefinition")<T, U> of([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<Queryable.Order<? super T, ? extends U>> orderBy, [ValueBound](valuebound "ValueBound")<? extends U> range) Factory method to create [WindowDefinition](windowdefinition "WindowDefinition") instance Parameters: `orderBy` - order definition `range` - the window bounds Type Parameters: `T` - the type of [Queryable](queryable "Queryable") element `U` - the type of field to sort Returns: the [WindowDefinition](windowdefinition "WindowDefinition") instance Since: 4.0.0 ### public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<Queryable.Order<? super T, ? extends U>> orderBy() Define order, similar to SQL's `order by` of window definition Returns: order definition Since: 4.0.0 ### public [Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ?> partitionBy() Define partition, similar to SQL's `partition by` of window definition Returns: partition definition ### public [ValueBound](valuebound "ValueBound")<? extends U> range() Define the window bounds by values, similar to MySQL's `range between 1.0 preceding and 1.0 following` of window definition Returns: range definition Since: 4.0.0 ### public [RowBound](rowbound) rows() Define the window bounds by offsets, similar to MySQL's `rows between 1 preceding and 1 following` of window definition Returns: rows definition Since: 4.0.0 ### public [WindowDefinition](windowdefinition "WindowDefinition")<T, U> setId([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") id) Set the id of window definition Parameters: `id` - the id of window definition Returns: self, i.e. current [WindowDefinition](windowdefinition "WindowDefinition") instance Since: 4.0.0 groovy [Groovy] Class QueryableHelper [Groovy] Class QueryableHelper ============================== * org.apache.groovy.ginq.provider.collection.runtime.QueryableHelper ``` @[Internal](../../../../../../../groovy/transform/internal "Internal") @[CompileStatic](../../../../../../../groovy/transform/compilestatic "CompileStatic") class QueryableHelper extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Helper for [Queryable](queryable "Queryable") Since: 4.0.0 Properties Summary ------------------ Properties \| Type \| Name and description \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[var](#var)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| `<T>` \| `static T` \| `[getVar](#getVar(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name)` \| \| \| `static boolean` \| `[isParallel](#isParallel())()` \| \| `<T>` \| `static [Queryable](queryable "Queryable")<[SourceRecord](sourcerecord "SourceRecord")<T>>` \| `[navigate](#navigate(Queryable,%20List))([Queryable](queryable "Queryable")<? extends T> queryable, [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> aliasList)`Make [Queryable](queryable "Queryable") instance's data source records being able to access via aliases \| \| `<T>` \| `static T` \| `[removeVar](#removeVar(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name)` \| \| `<T>` \| `static void` \| `[setVar](#setVar(java.lang.String,%20T))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, T value)` \| \| \| `static void` \| `[shutdown](#shutdown(int))(int mode)`Shutdown to release resources \| \| `<T>` \| `static T` \| `[singleValue](#singleValue(Queryable))([Queryable](queryable "Queryable")<? extends T> queryable)`Returns single value of [Queryable](queryable "Queryable") instance \| \| `<T>` \| `static ForkJoinTask<T>` \| `[submit](#submit(Callable))(Callable<T> callable)` \| \| `<U>` \| `static CompletableFuture<U>` \| `[supplyAsync](#supplyAsync(Supplier))(Supplier<U> supplier)` \| \| `<T, U>` \| `static CompletableFuture<U>` \| `[supplyAsync](#supplyAsync(Function,%20T))(Function<? super T, ? extends U> function, T param)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Property Detail --------------- ### [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") var Method Detail ------------- ### <T> static T getVar([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name) ### static boolean isParallel() ### <T> static [Queryable](queryable "Queryable")<[SourceRecord](sourcerecord "SourceRecord")<T>> navigate([Queryable](queryable "Queryable")<? extends T> queryable, [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> aliasList) Make [Queryable](queryable "Queryable") instance's data source records being able to access via aliases Parameters: `queryable` - the original [Queryable](queryable "Queryable") instance `aliasList` - the aliases of clause `from` and joins Returns: the result [Queryable](queryable "Queryable") instance Since: 4.0.0 ### <T> static T removeVar([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name) ### <T> static void setVar([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, T value) ### static void shutdown(int mode) Shutdown to release resources Parameters: `mode` - 0: immediate, 1: abort ### <T> static T singleValue([Queryable](queryable "Queryable")<? extends T> queryable) Returns single value of [Queryable](queryable "Queryable") instance throws: TooManyValuesException if the [Queryable](queryable "Queryable") instance contains more than one value Parameters: `queryable` - the [Queryable](queryable "Queryable") instance Returns: the single value Since: 4.0.0 ### <T> static ForkJoinTask<T> submit(Callable<T> callable) ### <U> static CompletableFuture<U> supplyAsync(Supplier<U> supplier) ### <T, U> static CompletableFuture<U> supplyAsync(Function<? super T, ? extends U> function, T param)	programming_docs
groovy [Java] Interface Queryable<T> [Java] Interface Queryable<T> ============================= ``` @[Internal](../../../../../../../groovy/transform/internal "Internal") public interface Queryable<T> ``` Represents the queryable objects, e.g. Java collections Type Parameters: `T` - the type of Queryable element Since: 4.0.0 Nested Class Summary -------------------- Nested classes \| Modifiers \| Name \| Description \| \| `class` \| `[Queryable.Order](queryable.order)` \| Represents an order rule \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| `<U>` \| `public U` \| `[agg](#agg(Function))([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super [Queryable](queryable "Queryable")<? extends T>, ? extends U> mapper)`The most powerful aggregate function in GINQ, it will receive the grouped result([Queryable](queryable "Queryable") instance) and apply any processing \| \| \| `public [BigDecimal](https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html "BigDecimal")` \| `[avg](#avg(Function))([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ? extends [Number](https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html "Number")> mapper)`Aggregate function `avg`, similar to SQL's `avg` \| \| \| `public [Long](https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html "Long")` \| `[count](#count())()`Aggreate function `count`, similar to SQL's `count` \| \| `<U>` \| `public [Long](https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html "Long")` \| `[count](#count(Function))([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ? extends U> mapper)`Aggregate function `count`, similar to SQL's `count` Note: if the chosen field is `null`, the field will not be counted \| \| `<U>` \| `public [Queryable](queryable "Queryable")<[Tuple2](../../../../../../../groovy/lang/tuple2 "Tuple2")<T, U>>` \| `[crossJoin](#crossJoin(Queryable))([Queryable](queryable "Queryable")<? extends U> queryable)`Cross join another [Queryable](queryable "Queryable") instance, similar to SQL's `cross join` \| \| \| `public [Queryable](queryable "Queryable")<T>` \| `[distinct](#distinct())()`Eliminate duplicated records, similar to SQL's `distinct` \| \| `<T>` \| `public static [Queryable](queryable "Queryable")<T>` \| `[emptyQueryable](#emptyQueryable())()`Returns the empty Queryable instance \| \| \| `public boolean` \| `[exists](#exists())()`Check if the result is empty, similar to SQL's `exists` \| \| `<T>` \| `public static [Queryable](queryable "Queryable")<T>` \| `[from](#from(Iterable))([Iterable](https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html "Iterable")<T> iterable)`Factory method to create [Queryable](queryable "Queryable") instance \| \| `<T>` \| `public static [Queryable](queryable "Queryable")<T>` \| `[from](#from(T))(T[] array)`Factory method to create [Queryable](queryable "Queryable") instance \| \| `<T>` \| `public static [Queryable](queryable "Queryable")<T>` \| `[from](#from(Stream))([Stream](https://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html "Stream")<T> sourceStream)`Factory method to create [Queryable](queryable "Queryable") instance \| \| `<T>` \| `public static [Queryable](queryable "Queryable")<T>` \| `[from](#from(Queryable))([Queryable](queryable "Queryable")<T> queryable)`Returns the original [Queryable](queryable "Queryable") instance directly \| \| `<U>` \| `public [Queryable](queryable "Queryable")<[Tuple2](../../../../../../../groovy/lang/tuple2 "Tuple2")<T, U>>` \| `[fullHashJoin](#fullHashJoin(Queryable,%20Function,%20Function))([Queryable](queryable "Queryable")<? extends U> queryable, [Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ?> fieldsExtractor1, [Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super U, ?> fieldsExtractor2)`Full hash join another [Queryable](queryable "Queryable") instance, similar to SQL's `full join` \| \| `<U>` \| `public [Queryable](queryable "Queryable")<[Tuple2](../../../../../../../groovy/lang/tuple2 "Tuple2")<T, U>>` \| `[fullJoin](#fullJoin(Queryable,%20BiPredicate))([Queryable](queryable "Queryable")<? extends U> queryable, [BiPredicate](https://docs.oracle.com/javase/8/docs/api/java/util/function/BiPredicate.html "BiPredicate")<? super T, ? super U> joiner)`Full join another [Queryable](queryable "Queryable") instance, similar to SQL's `full join` \| \| \| `public [Queryable](queryable "Queryable")<[Tuple2](../../../../../../../groovy/lang/tuple2 "Tuple2")<?, [Queryable](queryable "Queryable")<T>>>` \| `[groupBy](#groupBy(Function,%20Predicate))([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ?> classifier, [Predicate](https://docs.oracle.com/javase/8/docs/api/java/util/function/Predicate.html "Predicate")<? super [Tuple2](../../../../../../../groovy/lang/tuple2 "Tuple2")<?, [Queryable](queryable "Queryable")<? extends T>>> having)`Group by [Queryable](queryable "Queryable") instance, similar to SQL's `group by` \| \| \| `public [Queryable](queryable "Queryable")<[Tuple2](../../../../../../../groovy/lang/tuple2 "Tuple2")<?, [Queryable](queryable "Queryable")<T>>>` \| `[groupBy](#groupBy(Function))([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ?> classifier)`Group by [Queryable](queryable "Queryable") instance without `having` clause, similar to SQL's `group by` \| \| `<U>` \| `public [Queryable](queryable "Queryable")<[Tuple2](../../../../../../../groovy/lang/tuple2 "Tuple2")<T, U>>` \| `[innerHashJoin](#innerHashJoin(Queryable,%20Function,%20Function))([Queryable](queryable "Queryable")<? extends U> queryable, [Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ?> fieldsExtractor1, [Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super U, ?> fieldsExtractor2)`Inner hash join another [Queryable](queryable "Queryable") instance, similar to SQL's `inner hash join`. \| \| `<U>` \| `public [Queryable](queryable "Queryable")<[Tuple2](../../../../../../../groovy/lang/tuple2 "Tuple2")<T, U>>` \| `[innerJoin](#innerJoin(Queryable,%20BiPredicate))([Queryable](queryable "Queryable")<? extends U> queryable, [BiPredicate](https://docs.oracle.com/javase/8/docs/api/java/util/function/BiPredicate.html "BiPredicate")<? super T, ? super U> joiner)`Inner join another [Queryable](queryable "Queryable") instance, similar to SQL's `inner join` \| \| \| `public [Queryable](queryable "Queryable")<T>` \| `[intersect](#intersect(Queryable))([Queryable](queryable "Queryable")<? extends T> queryable)`Intersect another [Queryable](queryable "Queryable") instance, similar to SQL's `intersect` \| \| `<U>` \| `public [Queryable](queryable "Queryable")<[Tuple2](../../../../../../../groovy/lang/tuple2 "Tuple2")<T, U>>` \| `[leftHashJoin](#leftHashJoin(Queryable,%20Function,%20Function))([Queryable](queryable "Queryable")<? extends U> queryable, [Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ?> fieldsExtractor1, [Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super U, ?> fieldsExtractor2)`Left hash join another [Queryable](queryable "Queryable") instance, similar to SQL's `left hash join` \| \| `<U>` \| `public [Queryable](queryable "Queryable")<[Tuple2](../../../../../../../groovy/lang/tuple2 "Tuple2")<T, U>>` \| `[leftJoin](#leftJoin(Queryable,%20BiPredicate))([Queryable](queryable "Queryable")<? extends U> queryable, [BiPredicate](https://docs.oracle.com/javase/8/docs/api/java/util/function/BiPredicate.html "BiPredicate")<? super T, ? super U> joiner)`Left join another [Queryable](queryable "Queryable") instance, similar to SQL's `left join` \| \| \| `public [Queryable](queryable "Queryable")<T>` \| `[limit](#limit(long,%20long))(long offset, long size)`Paginate [Queryable](queryable "Queryable") instance, similar to MySQL's `limit` \| \| \| `public [Queryable](queryable "Queryable")<T>` \| `[limit](#limit(long))(long size)`Paginate [Queryable](queryable "Queryable") instance, similar to MySQL's `limit` \| \| `<U extends Comparable<? super U>>` \| `public U` \| `[max](#max(Function))([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ? extends U> mapper)`Aggregate function `max`, similar to SQL's `max` \| \| \| `public [BigDecimal](https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html "BigDecimal")` \| `[median](#median(Function))([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ? extends [Number](https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html "Number")> mapper)`Aggregate function `median`, similar to SQL's `median` \| \| `<U extends Comparable<? super U>>` \| `public U` \| `[min](#min(Function))([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ? extends U> mapper)`Aggregate function `min`, similar to SQL's `min` \| \| \| `public [Queryable](queryable "Queryable")<T>` \| `[minus](#minus(Queryable))([Queryable](queryable "Queryable")<? extends T> queryable)`Minus another [Queryable](queryable "Queryable") instance, similar to SQL's `minus` \| \| `<U extends Comparable<? super U>>` \| `public [Queryable](queryable "Queryable")<T>` \| `[orderBy](#orderBy(Order))(Order<? super T, ? extends U> orders)`Sort [Queryable](queryable "Queryable") instance, similar to SQL's `order by` \| \| `<U extends Comparable<? super U>>` \| `public [Queryable](queryable "Queryable")<T>` \| `[orderBy](#orderBy(List))([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<? extends Order<? super T, ? extends U>> orders)`Sort [Queryable](queryable "Queryable") instance, similar to SQL's `order by` \| \| `<U extends Comparable<? super U>>` \| `public [Window](window "Window")<T>` \| `[over](#over(Tuple2,%20WindowDefinition))([Tuple2](../../../../../../../groovy/lang/tuple2 "Tuple2")<T, [Long](https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html "Long")> currentRecord, [WindowDefinition](windowdefinition "WindowDefinition")<T, U> windowDefinition)`Open window for current record \| \| `<U>` \| `public [Queryable](queryable "Queryable")<[Tuple2](../../../../../../../groovy/lang/tuple2 "Tuple2")<T, U>>` \| `[rightHashJoin](#rightHashJoin(Queryable,%20Function,%20Function))([Queryable](queryable "Queryable")<? extends U> queryable, [Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ?> fieldsExtractor1, [Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super U, ?> fieldsExtractor2)`Right hash join another [Queryable](queryable "Queryable") instance, similar to SQL's `right join` \| \| `<U>` \| `public [Queryable](queryable "Queryable")<[Tuple2](../../../../../../../groovy/lang/tuple2 "Tuple2")<T, U>>` \| `[rightJoin](#rightJoin(Queryable,%20BiPredicate))([Queryable](queryable "Queryable")<? extends U> queryable, [BiPredicate](https://docs.oracle.com/javase/8/docs/api/java/util/function/BiPredicate.html "BiPredicate")<? super T, ? super U> joiner)`Right join another [Queryable](queryable "Queryable") instance, similar to SQL's `right join` \| \| `<U>` \| `public [Queryable](queryable "Queryable")<U>` \| `[select](#select(BiFunction))([BiFunction](https://docs.oracle.com/javase/8/docs/api/java/util/function/BiFunction.html "BiFunction")<? super T, ? super [Queryable](queryable "Queryable")<? extends T>, ? extends U> mapper)`Project [Queryable](queryable "Queryable") instance, similar to SQL's `select` \| \| \| `public long` \| `[size](#size())()`Returns the count of elements of the [Queryable](queryable "Queryable") instance \| \| \| `public [BigDecimal](https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html "BigDecimal")` \| `[stdev](#stdev(Function))([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ? extends [Number](https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html "Number")> mapper)`Aggregate function `stdev`, similar to SQL's `stdev` \| \| \| `public [BigDecimal](https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html "BigDecimal")` \| `[stdevp](#stdevp(Function))([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ? extends [Number](https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html "Number")> mapper)`Aggregate function `stdevp`, similar to SQL's `stdevp` \| \| \| `public [Stream](https://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html "Stream")<T>` \| `[stream](#stream())()`Create [Stream](https://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html "Stream")<T> object for the [Queryable](queryable "Queryable") instance \| \| \| `public [BigDecimal](https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html "BigDecimal")` \| `[sum](#sum(Function))([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ? extends [Number](https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html "Number")> mapper)`Aggregate function `sum`, similar to SQL's `sum` \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<T>` \| `[toList](#toList())()`Convert the [Queryable](queryable "Queryable") instance to [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<T> instance \| \| \| `public [Queryable](queryable "Queryable")<T>` \| `[union](#union(Queryable))([Queryable](queryable "Queryable")<? extends T> queryable)`Union another [Queryable](queryable "Queryable") instance, similar to SQL's `union` \| \| \| `public [Queryable](queryable "Queryable")<T>` \| `[unionAll](#unionAll(Queryable))([Queryable](queryable "Queryable")<? extends T> queryable)`Union all another [Queryable](queryable "Queryable") instance, similar to SQL's `union all` \| \| \| `public [BigDecimal](https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html "BigDecimal")` \| `[var](#var(Function))([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ? extends [Number](https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html "Number")> mapper)`Aggregate function `var`, similar to SQL's `var` \| \| \| `public [BigDecimal](https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html "BigDecimal")` \| `[varp](#varp(Function))([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ? extends [Number](https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html "Number")> mapper)`Aggregate function `varp`, similar to SQL's `varp` \| \| \| `public [Queryable](queryable "Queryable")<T>` \| `[where](#where(Predicate))([Predicate](https://docs.oracle.com/javase/8/docs/api/java/util/function/Predicate.html "Predicate")<? super T> filter)`Filter [Queryable](queryable "Queryable") instance via some condition, similar to SQL's `where` \| Method Detail ------------- ### <U> public U agg([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super [Queryable](queryable "Queryable")<? extends T>, ? extends U> mapper) The most powerful aggregate function in GINQ, it will receive the grouped result([Queryable](queryable "Queryable") instance) and apply any processing Parameters: `mapper` - map the grouped result([Queryable](queryable "Queryable") instance) to aggregate result Type Parameters: `U` - the type aggregate result Returns: aggregate result Since: 4.0.0 ### public [BigDecimal](https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html "BigDecimal") avg([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ? extends [Number](https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html "Number")> mapper) Aggregate function `avg`, similar to SQL's `avg` Parameters: `mapper` - choose the field to calculate the average Returns: avg result Since: 4.0.0 ### public [Long](https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html "Long") count() Aggreate function `count`, similar to SQL's `count` Returns: count result Since: 4.0.0 ### <U> public [Long](https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html "Long") count([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ? extends U> mapper) Aggregate function `count`, similar to SQL's `count` Note: if the chosen field is `null`, the field will not be counted Parameters: `mapper` - choose the field to count Returns: count result Since: 4.0.0 ### <U> public [Queryable](queryable "Queryable")<[Tuple2](../../../../../../../groovy/lang/tuple2 "Tuple2")<T, U>> crossJoin([Queryable](queryable "Queryable")<? extends U> queryable) Cross join another [Queryable](queryable "Queryable") instance, similar to SQL's `cross join` Parameters: `queryable` - another [Queryable](queryable "Queryable") instance Type Parameters: `U` - the type of element from another [Queryable](queryable "Queryable") instance Returns: the join result Since: 4.0.0 ### public [Queryable](queryable "Queryable")<T> distinct() Eliminate duplicated records, similar to SQL's `distinct` Returns: the distinct result Since: 4.0.0 ### <T> public static [Queryable](queryable "Queryable")<T> emptyQueryable() Returns the empty Queryable instance Type Parameters: `T` - the type of element Returns: the empty Queryable instance Since: 4.0.0 ### public boolean exists() Check if the result is empty, similar to SQL's `exists` Returns: the result of checking, `true` if result is not empty, otherwise `false` ### <T> public static [Queryable](queryable "Queryable")<T> from([Iterable](https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html "Iterable")<T> iterable) Factory method to create [Queryable](queryable "Queryable") instance Parameters: `iterable` - iterable object, e.g. [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") Type Parameters: `T` - the type of element Returns: the [Queryable](queryable "Queryable") instance Since: 4.0.0 ### <T> public static [Queryable](queryable "Queryable")<T> from(T[] array) Factory method to create [Queryable](queryable "Queryable") instance Parameters: `array` - array object Type Parameters: `T` - the type of element Returns: the [Queryable](queryable "Queryable") instance Since: 4.0.0 ### <T> public static [Queryable](queryable "Queryable")<T> from([Stream](https://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html "Stream")<T> sourceStream) Factory method to create [Queryable](queryable "Queryable") instance Parameters: `sourceStream` - stream object Type Parameters: `T` - the type of element Returns: the [Queryable](queryable "Queryable") instance Since: 4.0.0 ### <T> public static [Queryable](queryable "Queryable")<T> from([Queryable](queryable "Queryable")<T> queryable) Returns the original [Queryable](queryable "Queryable") instance directly Parameters: `queryable` - queryable object Type Parameters: `T` - the type of element Returns: the [Queryable](queryable "Queryable") instance Since: 4.0.0 ### <U> public [Queryable](queryable "Queryable")<[Tuple2](../../../../../../../groovy/lang/tuple2 "Tuple2")<T, U>> fullHashJoin([Queryable](queryable "Queryable")<? extends U> queryable, [Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ?> fieldsExtractor1, [Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super U, ?> fieldsExtractor2) Full hash join another [Queryable](queryable "Queryable") instance, similar to SQL's `full join` Parameters: `queryable` - another [Queryable](queryable "Queryable") instance `fieldsExtractor1` - extract fields of one data source `fieldsExtractor2` - extract fields of the other data source Type Parameters: `U` - the type of element from another [Queryable](queryable "Queryable") instance Returns: the join result Since: 4.0.0 ### <U> public [Queryable](queryable "Queryable")<[Tuple2](../../../../../../../groovy/lang/tuple2 "Tuple2")<T, U>> fullJoin([Queryable](queryable "Queryable")<? extends U> queryable, [BiPredicate](https://docs.oracle.com/javase/8/docs/api/java/util/function/BiPredicate.html "BiPredicate")<? super T, ? super U> joiner) Full join another [Queryable](queryable "Queryable") instance, similar to SQL's `full join` Parameters: `queryable` - another [Queryable](queryable "Queryable") instance `joiner` - join condition Type Parameters: `U` - the type of element from another [Queryable](queryable "Queryable") instance Returns: the join result Since: 4.0.0 ### public [Queryable](queryable "Queryable")<[Tuple2](../../../../../../../groovy/lang/tuple2 "Tuple2")<?, [Queryable](queryable "Queryable")<T>>> groupBy([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ?> classifier, [Predicate](https://docs.oracle.com/javase/8/docs/api/java/util/function/Predicate.html "Predicate")<? super [Tuple2](../../../../../../../groovy/lang/tuple2 "Tuple2")<?, [Queryable](queryable "Queryable")<? extends T>>> having) Group by [Queryable](queryable "Queryable") instance, similar to SQL's `group by` Parameters: `classifier` - the classifier for group by `having` - the filter condition Returns: the result of group by Since: 4.0.0 ### public [Queryable](queryable "Queryable")<[Tuple2](../../../../../../../groovy/lang/tuple2 "Tuple2")<?, [Queryable](queryable "Queryable")<T>>> groupBy([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ?> classifier) Group by [Queryable](queryable "Queryable") instance without `having` clause, similar to SQL's `group by` Parameters: `classifier` - the classifier for group by Returns: the result of group by Since: 4.0.0 ### <U> public [Queryable](queryable "Queryable")<[Tuple2](../../../../../../../groovy/lang/tuple2 "Tuple2")<T, U>> innerHashJoin([Queryable](queryable "Queryable")<? extends U> queryable, [Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ?> fieldsExtractor1, [Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super U, ?> fieldsExtractor2) Inner hash join another [Queryable](queryable "Queryable") instance, similar to SQL's `inner hash join`. Note: Inner hash join requires equijoin predicate, e.g. `on a == b` Parameters: `queryable` - another [Queryable](queryable "Queryable") instance `fieldsExtractor1` - extract fields of one data source `fieldsExtractor2` - extract fields of the other data source Type Parameters: `U` - the type of element from another [Queryable](queryable "Queryable") instance Returns: the join result Since: 4.0.0 ### <U> public [Queryable](queryable "Queryable")<[Tuple2](../../../../../../../groovy/lang/tuple2 "Tuple2")<T, U>> innerJoin([Queryable](queryable "Queryable")<? extends U> queryable, [BiPredicate](https://docs.oracle.com/javase/8/docs/api/java/util/function/BiPredicate.html "BiPredicate")<? super T, ? super U> joiner) Inner join another [Queryable](queryable "Queryable") instance, similar to SQL's `inner join` Parameters: `queryable` - another [Queryable](queryable "Queryable") instance `joiner` - join condition Type Parameters: `U` - the type of element from another [Queryable](queryable "Queryable") instance Returns: the join result Since: 4.0.0 ### public [Queryable](queryable "Queryable")<T> intersect([Queryable](queryable "Queryable")<? extends T> queryable) Intersect another [Queryable](queryable "Queryable") instance, similar to SQL's `intersect` Parameters: `queryable` - the other [Queryable](queryable "Queryable") instance Returns: the intersect result Since: 4.0.0 ### <U> public [Queryable](queryable "Queryable")<[Tuple2](../../../../../../../groovy/lang/tuple2 "Tuple2")<T, U>> leftHashJoin([Queryable](queryable "Queryable")<? extends U> queryable, [Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ?> fieldsExtractor1, [Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super U, ?> fieldsExtractor2) Left hash join another [Queryable](queryable "Queryable") instance, similar to SQL's `left hash join` Parameters: `queryable` - another [Queryable](queryable "Queryable") instance `fieldsExtractor1` - extract fields of one data source `fieldsExtractor2` - extract fields of the other data source Type Parameters: `U` - the type of element from another [Queryable](queryable "Queryable") instance Returns: the join result Since: 4.0.0 ### <U> public [Queryable](queryable "Queryable")<[Tuple2](../../../../../../../groovy/lang/tuple2 "Tuple2")<T, U>> leftJoin([Queryable](queryable "Queryable")<? extends U> queryable, [BiPredicate](https://docs.oracle.com/javase/8/docs/api/java/util/function/BiPredicate.html "BiPredicate")<? super T, ? super U> joiner) Left join another [Queryable](queryable "Queryable") instance, similar to SQL's `left join` Parameters: `queryable` - another [Queryable](queryable "Queryable") instance `joiner` - join condition Type Parameters: `U` - the type of element from another [Queryable](queryable "Queryable") instance Returns: the join result Since: 4.0.0 ### public [Queryable](queryable "Queryable")<T> limit(long offset, long size) Paginate [Queryable](queryable "Queryable") instance, similar to MySQL's `limit` Parameters: `offset` - the start position `size` - the size to take Returns: the result of paginating Since: 4.0.0 ### public [Queryable](queryable "Queryable")<T> limit(long size) Paginate [Queryable](queryable "Queryable") instance, similar to MySQL's `limit` Parameters: `size` - the size to take Returns: the result of paginating Since: 4.0.0 ### <U extends Comparable<? super U>> public U max([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ? extends U> mapper) Aggregate function `max`, similar to SQL's `max` Parameters: `mapper` - choose the field to find the maximum Type Parameters: `U` - the field type Returns: min result Since: 4.0.0 ### public [BigDecimal](https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html "BigDecimal") median([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ? extends [Number](https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html "Number")> mapper) Aggregate function `median`, similar to SQL's `median` Parameters: `mapper` - choose the field to median Returns: median result Since: 4.0.0 ### <U extends Comparable<? super U>> public U min([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ? extends U> mapper) Aggregate function `min`, similar to SQL's `min` Parameters: `mapper` - choose the field to find the minimum Type Parameters: `U` - the field type Returns: min result Since: 4.0.0 ### public [Queryable](queryable "Queryable")<T> minus([Queryable](queryable "Queryable")<? extends T> queryable) Minus another [Queryable](queryable "Queryable") instance, similar to SQL's `minus` Parameters: `queryable` - the other [Queryable](queryable "Queryable") instance Returns: the minus result Since: 4.0.0 ### <U extends Comparable<? super U>> public [Queryable](queryable "Queryable")<T> orderBy(Order<? super T, ? extends U> orders) Sort [Queryable](queryable "Queryable") instance, similar to SQL's `order by` Parameters: `orders` - the order rules for sorting Type Parameters: `U` - the type of field to sort Returns: the result of order by Since: 4.0.0 ### <U extends Comparable<? super U>> public [Queryable](queryable "Queryable")<T> orderBy([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<? extends Order<? super T, ? extends U>> orders) Sort [Queryable](queryable "Queryable") instance, similar to SQL's `order by` Parameters: `orders` - the order rules for sorting Type Parameters: `U` - the type of field to sort Returns: the result of order by Since: 4.0.0 ### <U extends Comparable<? super U>> public [Window](window "Window")<T> over([Tuple2](../../../../../../../groovy/lang/tuple2 "Tuple2")<T, [Long](https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html "Long")> currentRecord, [WindowDefinition](windowdefinition "WindowDefinition")<T, U> windowDefinition) Open window for current record Parameters: `currentRecord` - current record `windowDefinition` - window definition Type Parameters: `U` - the type of window value Returns: the window ### <U> public [Queryable](queryable "Queryable")<[Tuple2](../../../../../../../groovy/lang/tuple2 "Tuple2")<T, U>> rightHashJoin([Queryable](queryable "Queryable")<? extends U> queryable, [Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ?> fieldsExtractor1, [Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super U, ?> fieldsExtractor2) Right hash join another [Queryable](queryable "Queryable") instance, similar to SQL's `right join` Parameters: `queryable` - another [Queryable](queryable "Queryable") instance `fieldsExtractor1` - extract fields of one data source `fieldsExtractor2` - extract fields of the other data source Type Parameters: `U` - the type of element from another [Queryable](queryable "Queryable") instance Returns: the join result Since: 4.0.0 ### <U> public [Queryable](queryable "Queryable")<[Tuple2](../../../../../../../groovy/lang/tuple2 "Tuple2")<T, U>> rightJoin([Queryable](queryable "Queryable")<? extends U> queryable, [BiPredicate](https://docs.oracle.com/javase/8/docs/api/java/util/function/BiPredicate.html "BiPredicate")<? super T, ? super U> joiner) Right join another [Queryable](queryable "Queryable") instance, similar to SQL's `right join` Parameters: `queryable` - another [Queryable](queryable "Queryable") instance `joiner` - join condition Type Parameters: `U` - the type of element from another [Queryable](queryable "Queryable") instance Returns: the join result Since: 4.0.0 ### <U> public [Queryable](queryable "Queryable")<U> select([BiFunction](https://docs.oracle.com/javase/8/docs/api/java/util/function/BiFunction.html "BiFunction")<? super T, ? super [Queryable](queryable "Queryable")<? extends T>, ? extends U> mapper) Project [Queryable](queryable "Queryable") instance, similar to SQL's `select` Parameters: `mapper` - project fields Type Parameters: `U` - the type of project record Returns: the result of projecting Since: 4.0.0 ### public long size() Returns the count of elements of the [Queryable](queryable "Queryable") instance Returns: the count of elements of the [Queryable](queryable "Queryable") instance Since: 4.0.0 ### public [BigDecimal](https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html "BigDecimal") stdev([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ? extends [Number](https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html "Number")> mapper) Aggregate function `stdev`, similar to SQL's `stdev` Parameters: `mapper` - choose the field to calculate the statistical standard deviation Returns: statistical standard deviation Since: 4.0.0 ### public [BigDecimal](https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html "BigDecimal") stdevp([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ? extends [Number](https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html "Number")> mapper) Aggregate function `stdevp`, similar to SQL's `stdevp` Parameters: `mapper` - choose the field to calculate the statistical standard deviation for the population Returns: statistical standard deviation for the population Since: 4.0.0 ### public [Stream](https://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html "Stream")<T> stream() Create [Stream](https://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html "Stream")<T> object for the [Queryable](queryable "Queryable") instance Returns: the result stream Since: 4.0.0 ### public [BigDecimal](https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html "BigDecimal") sum([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ? extends [Number](https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html "Number")> mapper) Aggregate function `sum`, similar to SQL's `sum` Parameters: `mapper` - choose the field to sum Returns: sum result Since: 4.0.0 ### public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<T> toList() Convert the [Queryable](queryable "Queryable") instance to [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<T> instance Returns: the result list Since: 4.0.0 ### public [Queryable](queryable "Queryable")<T> union([Queryable](queryable "Queryable")<? extends T> queryable) Union another [Queryable](queryable "Queryable") instance, similar to SQL's `union` Parameters: `queryable` - the other [Queryable](queryable "Queryable") instance Returns: the union result Since: 4.0.0 ### public [Queryable](queryable "Queryable")<T> unionAll([Queryable](queryable "Queryable")<? extends T> queryable) Union all another [Queryable](queryable "Queryable") instance, similar to SQL's `union all` Parameters: `queryable` - the other [Queryable](queryable "Queryable") instance Returns: the union all result Since: 4.0.0 ### public [BigDecimal](https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html "BigDecimal") var([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ? extends [Number](https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html "Number")> mapper) Aggregate function `var`, similar to SQL's `var` Parameters: `mapper` - choose the field to calculate the statistical variance Returns: statistical variance Since: 4.0.0 ### public [BigDecimal](https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html "BigDecimal") varp([Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<? super T, ? extends [Number](https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html "Number")> mapper) Aggregate function `varp`, similar to SQL's `varp` Parameters: `mapper` - choose the field to calculate the statistical variance for the population Returns: statistical variance for the population Since: 4.0.0 ### public [Queryable](queryable "Queryable")<T> where([Predicate](https://docs.oracle.com/javase/8/docs/api/java/util/function/Predicate.html "Predicate")<? super T> filter) Filter [Queryable](queryable "Queryable") instance via some condition, similar to SQL's `where` Parameters: `filter` - the filter condition Returns: filter result Since: 4.0.0	programming_docs
groovy [Groovy] Class NamedRecord<E, T> [Groovy] Class NamedRecord<E, T> ================================ * org.apache.groovy.ginq.provider.collection.runtime.NamedRecord ``` @[POJO](../../../../../../../groovy/transform/stc/pojo "POJO") @[CompileStatic](../../../../../../../groovy/transform/compilestatic "CompileStatic") class NamedRecord<E, T> extends [NamedTuple](namedtuple "NamedTuple")<E> ``` Represents named record, which is constructed by clauses excluding `from` and joins Since: 4.0.0 Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[NamedRecord](#NamedRecord(List,%20List,%20List))([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<E> elementList, [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> nameList, [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> aliasList)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>` \| `[getAliasList](#getAliasList())()` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getAt](#getAt(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name)` \| \| \| `[NamedRecord](namedrecord "NamedRecord")<E, T>` \| `[sourceRecord](#sourceRecord(T))(T sr)` \| Constructor Detail ------------------ ### NamedRecord([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<E> elementList, [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> nameList, [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> aliasList) Method Detail ------------- ### [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> getAliasList() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getAt([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name) ### [NamedRecord](namedrecord "NamedRecord")<E, T> sourceRecord(T sr) groovy [Java] Class GinqASTTransformation [Java] Class GinqASTTransformation ================================== * org.apache.groovy.ginq.transform.GinqASTTransformation ``` @[GroovyASTTransformation](../../../../codehaus/groovy/transform/groovyasttransformation "GroovyASTTransformation")(phase = CompilePhase.SEMANTIC_ANALYSIS) public class GinqASTTransformation extends [AbstractASTTransformation](../../../../codehaus/groovy/transform/abstractasttransformation) ``` Handles generation of code for the `@GQ` annotation. Since: 4.0.0 Inherited fields \| Fields inherited from class \| Fields \| \| `class [AbstractASTTransformation](../../../../codehaus/groovy/transform/abstractasttransformation)` \| `[RETENTION\_CLASSNODE](../../../../codehaus/groovy/transform/abstractasttransformation#RETENTION_CLASSNODE), [sourceUnit](../../../../codehaus/groovy/transform/abstractasttransformation#sourceUnit)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public void` \| `[visit](#visit(org.codehaus.groovy.ast.ASTNode,%20org.codehaus.groovy.control.SourceUnit))([ASTNode](../../../../codehaus/groovy/ast/astnode)[] nodes, [SourceUnit](../../../../codehaus/groovy/control/sourceunit) sourceUnit)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractASTTransformation](../../../../codehaus/groovy/transform/abstractasttransformation)` \| `[addError](../../../../codehaus/groovy/transform/abstractasttransformation#addError(java.lang.String,%20org.codehaus.groovy.ast.ASTNode)), [checkIncludeExcludeUndefinedAware](../../../../codehaus/groovy/transform/abstractasttransformation#checkIncludeExcludeUndefinedAware(org.codehaus.groovy.ast.AnnotationNode,%20List,%20List,%20java.lang.String)), [checkIncludeExcludeUndefinedAware](../../../../codehaus/groovy/transform/abstractasttransformation#checkIncludeExcludeUndefinedAware(org.codehaus.groovy.ast.AnnotationNode,%20List,%20List,%20List,%20List,%20java.lang.String)), [checkNotInterface](../../../../codehaus/groovy/transform/abstractasttransformation#checkNotInterface(org.codehaus.groovy.ast.ClassNode,%20java.lang.String)), [checkPropertyList](../../../../codehaus/groovy/transform/abstractasttransformation#checkPropertyList(org.codehaus.groovy.ast.ClassNode,%20List,%20java.lang.String,%20org.codehaus.groovy.ast.AnnotationNode,%20java.lang.String,%20boolean)), [checkPropertyList](../../../../codehaus/groovy/transform/abstractasttransformation#checkPropertyList(org.codehaus.groovy.ast.ClassNode,%20List,%20java.lang.String,%20org.codehaus.groovy.ast.AnnotationNode,%20java.lang.String,%20boolean,%20boolean,%20boolean)), [checkPropertyList](../../../../codehaus/groovy/transform/abstractasttransformation#checkPropertyList(org.codehaus.groovy.ast.ClassNode,%20List,%20java.lang.String,%20org.codehaus.groovy.ast.AnnotationNode,%20java.lang.String,%20boolean,%20boolean,%20boolean,%20boolean,%20boolean)), [copyAnnotatedNodeAnnotations](../../../../codehaus/groovy/transform/abstractasttransformation#copyAnnotatedNodeAnnotations(org.codehaus.groovy.ast.AnnotatedNode,%20java.lang.String)), [copyAnnotatedNodeAnnotations](../../../../codehaus/groovy/transform/abstractasttransformation#copyAnnotatedNodeAnnotations(org.codehaus.groovy.ast.AnnotatedNode,%20java.lang.String,%20boolean)), [deemedInternalName](../../../../codehaus/groovy/transform/abstractasttransformation#deemedInternalName(java.lang.String)), [getAnnotationName](../../../../codehaus/groovy/transform/abstractasttransformation#getAnnotationName()), [getMemberClassList](../../../../codehaus/groovy/transform/abstractasttransformation#getMemberClassList(org.codehaus.groovy.ast.AnnotationNode,%20java.lang.String)), [getMemberClassValue](../../../../codehaus/groovy/transform/abstractasttransformation#getMemberClassValue(org.codehaus.groovy.ast.AnnotationNode,%20java.lang.String)), [getMemberClassValue](../../../../codehaus/groovy/transform/abstractasttransformation#getMemberClassValue(org.codehaus.groovy.ast.AnnotationNode,%20java.lang.String,%20org.codehaus.groovy.ast.ClassNode)), [getMemberIntValue](../../../../codehaus/groovy/transform/abstractasttransformation#getMemberIntValue(org.codehaus.groovy.ast.AnnotationNode,%20java.lang.String)), [getMemberStringList](../../../../codehaus/groovy/transform/abstractasttransformation#getMemberStringList(org.codehaus.groovy.ast.AnnotationNode,%20java.lang.String)), [getMemberStringValue](../../../../codehaus/groovy/transform/abstractasttransformation#getMemberStringValue(org.codehaus.groovy.ast.AnnotationNode,%20java.lang.String,%20java.lang.String)), [getMemberStringValue](../../../../codehaus/groovy/transform/abstractasttransformation#getMemberStringValue(org.codehaus.groovy.ast.AnnotationNode,%20java.lang.String)), [getMemberValue](../../../../codehaus/groovy/transform/abstractasttransformation#getMemberValue(org.codehaus.groovy.ast.AnnotationNode,%20java.lang.String)), [hasAnnotation](../../../../codehaus/groovy/transform/abstractasttransformation#hasAnnotation(org.codehaus.groovy.ast.ClassNode,%20org.codehaus.groovy.ast.ClassNode)), [init](../../../../codehaus/groovy/transform/abstractasttransformation#init(org.codehaus.groovy.ast.ASTNode,%20org.codehaus.groovy.control.SourceUnit)), [memberHasValue](../../../../codehaus/groovy/transform/abstractasttransformation#memberHasValue(org.codehaus.groovy.ast.AnnotationNode,%20java.lang.String,%20java.lang.Object)), [shouldSkip](../../../../codehaus/groovy/transform/abstractasttransformation#shouldSkip(java.lang.String,%20List,%20List)), [shouldSkip](../../../../codehaus/groovy/transform/abstractasttransformation#shouldSkip(java.lang.String,%20List,%20List,%20boolean)), [shouldSkipOnDescriptorUndefinedAware](../../../../codehaus/groovy/transform/abstractasttransformation#shouldSkipOnDescriptorUndefinedAware(boolean,%20java.util.Map,%20org.codehaus.groovy.ast.MethodNode,%20List,%20List)), [shouldSkipUndefinedAware](../../../../codehaus/groovy/transform/abstractasttransformation#shouldSkipUndefinedAware(java.lang.String,%20List,%20List)), [shouldSkipUndefinedAware](../../../../codehaus/groovy/transform/abstractasttransformation#shouldSkipUndefinedAware(java.lang.String,%20List,%20List,%20boolean)), [tokenize](../../../../codehaus/groovy/transform/abstractasttransformation#tokenize(java.lang.String))` \| Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void visit([ASTNode](../../../../codehaus/groovy/ast/astnode)[] nodes, [SourceUnit](../../../../codehaus/groovy/control/sourceunit) sourceUnit) groovy [Groovy] Class GinqAstOptimizer.3 [Groovy] Class GinqAstOptimizer.3 ================================= * org.apache.groovy.ginq.dsl.GinqAstOptimizer.3 ``` class GinqAstOptimizer.3 extends [GinqAstBaseVisitor](ginqastbasevisitor) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[GinqAstOptimizer.3](#GinqAstOptimizer.3())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `void` \| `[visitVariableExpression](#visitVariableExpression(org.codehaus.groovy.ast.expr.VariableExpression))([VariableExpression](../../../../codehaus/groovy/ast/expr/variableexpression) variableExpression)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [GinqAstBaseVisitor](ginqastbasevisitor)` \| `[visit](ginqastbasevisitor#visit(org.apache.groovy.ginq.dsl.expression.AbstractGinqExpression)), [visitFromExpression](ginqastbasevisitor#visitFromExpression(org.apache.groovy.ginq.dsl.expression.FromExpression)), [visitGinqExpression](ginqastbasevisitor#visitGinqExpression(org.apache.groovy.ginq.dsl.expression.GinqExpression)), [visitGroupExpression](ginqastbasevisitor#visitGroupExpression(org.apache.groovy.ginq.dsl.expression.GroupExpression)), [visitHavingExpression](ginqastbasevisitor#visitHavingExpression(org.apache.groovy.ginq.dsl.expression.HavingExpression)), [visitJoinExpression](ginqastbasevisitor#visitJoinExpression(org.apache.groovy.ginq.dsl.expression.JoinExpression)), [visitLimitExpression](ginqastbasevisitor#visitLimitExpression(org.apache.groovy.ginq.dsl.expression.LimitExpression)), [visitOnExpression](ginqastbasevisitor#visitOnExpression(org.apache.groovy.ginq.dsl.expression.OnExpression)), [visitOrderExpression](ginqastbasevisitor#visitOrderExpression(org.apache.groovy.ginq.dsl.expression.OrderExpression)), [visitSelectExpression](ginqastbasevisitor#visitSelectExpression(org.apache.groovy.ginq.dsl.expression.SelectExpression)), [visitShutdownExpression](ginqastbasevisitor#visitShutdownExpression(org.apache.groovy.ginq.dsl.expression.ShutdownExpression)), [visitWhereExpression](ginqastbasevisitor#visitWhereExpression(org.apache.groovy.ginq.dsl.expression.WhereExpression))` \| \| `class [CodeVisitorSupport](../../../../codehaus/groovy/ast/codevisitorsupport)` \| `[afterSwitchConditionExpressionVisited](../../../../codehaus/groovy/ast/codevisitorsupport#afterSwitchConditionExpressionVisited(org.codehaus.groovy.ast.stmt.SwitchStatement)), [visitArgumentlistExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitArgumentlistExpression(org.codehaus.groovy.ast.expr.ArgumentListExpression)), [visitArrayExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitArrayExpression(org.codehaus.groovy.ast.expr.ArrayExpression)), [visitAssertStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitAssertStatement(org.codehaus.groovy.ast.stmt.AssertStatement)), [visitAttributeExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitAttributeExpression(org.codehaus.groovy.ast.expr.AttributeExpression)), [visitBinaryExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitBinaryExpression(org.codehaus.groovy.ast.expr.BinaryExpression)), [visitBitwiseNegationExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitBitwiseNegationExpression(org.codehaus.groovy.ast.expr.BitwiseNegationExpression)), [visitBlockStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitBlockStatement(org.codehaus.groovy.ast.stmt.BlockStatement)), [visitBooleanExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitBooleanExpression(org.codehaus.groovy.ast.expr.BooleanExpression)), [visitBreakStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitBreakStatement(org.codehaus.groovy.ast.stmt.BreakStatement)), [visitBytecodeExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitBytecodeExpression(org.codehaus.groovy.classgen.BytecodeExpression)), [visitCaseStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitCaseStatement(org.codehaus.groovy.ast.stmt.CaseStatement)), [visitCastExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitCastExpression(org.codehaus.groovy.ast.expr.CastExpression)), [visitCatchStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitCatchStatement(org.codehaus.groovy.ast.stmt.CatchStatement)), [visitClassExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitClassExpression(org.codehaus.groovy.ast.expr.ClassExpression)), [visitClosureExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitClosureExpression(org.codehaus.groovy.ast.expr.ClosureExpression)), [visitClosureListExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitClosureListExpression(org.codehaus.groovy.ast.expr.ClosureListExpression)), [visitConstantExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitConstantExpression(org.codehaus.groovy.ast.expr.ConstantExpression)), [visitConstructorCallExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitConstructorCallExpression(org.codehaus.groovy.ast.expr.ConstructorCallExpression)), [visitContinueStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitContinueStatement(org.codehaus.groovy.ast.stmt.ContinueStatement)), [visitDeclarationExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitDeclarationExpression(org.codehaus.groovy.ast.expr.DeclarationExpression)), [visitDoWhileLoop](../../../../codehaus/groovy/ast/codevisitorsupport#visitDoWhileLoop(org.codehaus.groovy.ast.stmt.DoWhileStatement)), [visitEmptyStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitEmptyStatement(org.codehaus.groovy.ast.stmt.EmptyStatement)), [visitExpressionStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitExpressionStatement(org.codehaus.groovy.ast.stmt.ExpressionStatement)), [visitFieldExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitFieldExpression(org.codehaus.groovy.ast.expr.FieldExpression)), [visitForLoop](../../../../codehaus/groovy/ast/codevisitorsupport#visitForLoop(org.codehaus.groovy.ast.stmt.ForStatement)), [visitGStringExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitGStringExpression(org.codehaus.groovy.ast.expr.GStringExpression)), [visitIfElse](../../../../codehaus/groovy/ast/codevisitorsupport#visitIfElse(org.codehaus.groovy.ast.stmt.IfStatement)), [visitLambdaExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitLambdaExpression(org.codehaus.groovy.ast.expr.LambdaExpression)), [visitListExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitListExpression(org.codehaus.groovy.ast.expr.ListExpression)), [visitMapEntryExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitMapEntryExpression(org.codehaus.groovy.ast.expr.MapEntryExpression)), [visitMapExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitMapExpression(org.codehaus.groovy.ast.expr.MapExpression)), [visitMethodCallExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitMethodCallExpression(org.codehaus.groovy.ast.expr.MethodCallExpression)), [visitMethodPointerExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitMethodPointerExpression(org.codehaus.groovy.ast.expr.MethodPointerExpression)), [visitMethodReferenceExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitMethodReferenceExpression(org.codehaus.groovy.ast.expr.MethodReferenceExpression)), [visitNotExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitNotExpression(org.codehaus.groovy.ast.expr.NotExpression)), [visitPostfixExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitPostfixExpression(org.codehaus.groovy.ast.expr.PostfixExpression)), [visitPrefixExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitPrefixExpression(org.codehaus.groovy.ast.expr.PrefixExpression)), [visitPropertyExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitPropertyExpression(org.codehaus.groovy.ast.expr.PropertyExpression)), [visitRangeExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitRangeExpression(org.codehaus.groovy.ast.expr.RangeExpression)), [visitReturnStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitReturnStatement(org.codehaus.groovy.ast.stmt.ReturnStatement)), [visitShortTernaryExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitShortTernaryExpression(org.codehaus.groovy.ast.expr.ElvisOperatorExpression)), [visitSpreadExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitSpreadExpression(org.codehaus.groovy.ast.expr.SpreadExpression)), [visitSpreadMapExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitSpreadMapExpression(org.codehaus.groovy.ast.expr.SpreadMapExpression)), [visitStaticMethodCallExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitStaticMethodCallExpression(org.codehaus.groovy.ast.expr.StaticMethodCallExpression)), [visitSwitch](../../../../codehaus/groovy/ast/codevisitorsupport#visitSwitch(org.codehaus.groovy.ast.stmt.SwitchStatement)), [visitSynchronizedStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitSynchronizedStatement(org.codehaus.groovy.ast.stmt.SynchronizedStatement)), [visitTernaryExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitTernaryExpression(org.codehaus.groovy.ast.expr.TernaryExpression)), [visitThrowStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitThrowStatement(org.codehaus.groovy.ast.stmt.ThrowStatement)), [visitTryCatchFinally](../../../../codehaus/groovy/ast/codevisitorsupport#visitTryCatchFinally(org.codehaus.groovy.ast.stmt.TryCatchStatement)), [visitTupleExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitTupleExpression(org.codehaus.groovy.ast.expr.TupleExpression)), [visitUnaryMinusExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitUnaryMinusExpression(org.codehaus.groovy.ast.expr.UnaryMinusExpression)), [visitUnaryPlusExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitUnaryPlusExpression(org.codehaus.groovy.ast.expr.UnaryPlusExpression)), [visitVariableExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitVariableExpression(org.codehaus.groovy.ast.expr.VariableExpression)), [visitWhileLoop](../../../../codehaus/groovy/ast/codevisitorsupport#visitWhileLoop(org.codehaus.groovy.ast.stmt.WhileStatement))` \| Constructor Detail ------------------ ### GinqAstOptimizer.3() Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") void visitVariableExpression([VariableExpression](../../../../codehaus/groovy/ast/expr/variableexpression) variableExpression)	programming_docs
groovy [Groovy] Class GinqAstOptimizer.2 [Groovy] Class GinqAstOptimizer.2 ================================= * org.apache.groovy.ginq.dsl.GinqAstOptimizer.2 ``` class GinqAstOptimizer.2 extends [ExpressionTransformer](../../../../codehaus/groovy/ast/expr/expressiontransformer) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[GinqAstOptimizer.2](#GinqAstOptimizer.2())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Expression](../../../../codehaus/groovy/ast/expr/expression)` \| `[transform](#transform(org.codehaus.groovy.ast.expr.Expression))([Expression](../../../../codehaus/groovy/ast/expr/expression) expr)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `interface [ExpressionTransformer](../../../../codehaus/groovy/ast/expr/expressiontransformer)` \| `[transform](../../../../codehaus/groovy/ast/expr/expressiontransformer#transform(org.codehaus.groovy.ast.expr.Expression))` \| Constructor Detail ------------------ ### GinqAstOptimizer.2() Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") [Expression](../../../../codehaus/groovy/ast/expr/expression) transform([Expression](../../../../codehaus/groovy/ast/expr/expression) expr) groovy [Java] Interface SyntaxErrorReportable [Java] Interface SyntaxErrorReportable ====================================== ``` public interface SyntaxErrorReportable ``` Supports reporting the syntax error of GINQ Since: 4.0.0 Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public void` \| `[collectSyntaxError](#collectSyntaxError(org.apache.groovy.ginq.dsl.GinqSyntaxError))([GinqSyntaxError](ginqsyntaxerror) ginqSyntaxError)` \| \| \| `public [SourceUnit](../../../../codehaus/groovy/control/sourceunit)` \| `[getSourceUnit](#getSourceUnit())()` \| Method Detail ------------- ### public void collectSyntaxError([GinqSyntaxError](ginqsyntaxerror) ginqSyntaxError) ### public [SourceUnit](../../../../codehaus/groovy/control/sourceunit) getSourceUnit() groovy [Java] Class GinqSyntaxError [Java] Class GinqSyntaxError ============================ * org.apache.groovy.ginq.dsl.GinqSyntaxError ``` public class GinqSyntaxError extends [AssertionError](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html "AssertionError") ``` Represents GINQ syntax error Since: 4.0.0 Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[GinqSyntaxError](#GinqSyntaxError(java.lang.String,%20org.codehaus.groovy.ast.expr.Expression))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message, [Expression](../../../../codehaus/groovy/ast/expr/expression) expression)` \| \| `[GinqSyntaxError](#GinqSyntaxError(java.lang.String,%20int,%20int))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message, int line, int column)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public int` \| `[getColumn](#getColumn())()` \| \| \| `public int` \| `[getLine](#getLine())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AssertionError](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html "AssertionError")` \| `[printStackTrace](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html#printStackTrace() "printStackTrace"), [printStackTrace](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html#printStackTrace(java.io.PrintStream) "printStackTrace"), [printStackTrace](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html#printStackTrace(java.io.PrintWriter) "printStackTrace"), [fillInStackTrace](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html#fillInStackTrace() "fillInStackTrace"), [getCause](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html#getCause() "getCause"), [initCause](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html#initCause(java.lang.Throwable) "initCause"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html#toString() "toString"), [getMessage](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html#getMessage() "getMessage"), [getSuppressed](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html#getSuppressed() "getSuppressed"), [getLocalizedMessage](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html#getLocalizedMessage() "getLocalizedMessage"), [getStackTrace](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html#getStackTrace() "getStackTrace"), [setStackTrace](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html#setStackTrace(%5BLjava.lang.StackTraceElement;) "setStackTrace"), [addSuppressed](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html#addSuppressed(java.lang.Throwable) "addSuppressed"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html#equals(java.lang.Object) "equals"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public GinqSyntaxError([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message, [Expression](../../../../codehaus/groovy/ast/expr/expression) expression) ### public GinqSyntaxError([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message, int line, int column) Method Detail ------------- ### public int getColumn() ### public int getLine() groovy [Java] Interface GinqAstVisitor<R> [Java] Interface GinqAstVisitor<R> ================================== ``` public interface GinqAstVisitor<R> ``` Represents the visitor for AST of GINQ Type Parameters: `R` - the type of visit result Since: 4.0.0 Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>` \| `[getConfiguration](#getConfiguration())()` \| \| \| `public void` \| `[setConfiguration](#setConfiguration(Map))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> configuration)` \| \| \| `public R` \| `[visit](#visit(org.apache.groovy.ginq.dsl.expression.AbstractGinqExpression))([AbstractGinqExpression](expression/abstractginqexpression) expression)` \| \| \| `public R` \| `[visitFromExpression](#visitFromExpression(org.apache.groovy.ginq.dsl.expression.FromExpression))([FromExpression](expression/fromexpression) fromExpression)` \| \| \| `public R` \| `[visitGinqExpression](#visitGinqExpression(org.apache.groovy.ginq.dsl.expression.GinqExpression))([GinqExpression](expression/ginqexpression) ginqExpression)` \| \| \| `public R` \| `[visitGroupExpression](#visitGroupExpression(org.apache.groovy.ginq.dsl.expression.GroupExpression))([GroupExpression](expression/groupexpression) groupExpression)` \| \| \| `public R` \| `[visitHavingExpression](#visitHavingExpression(org.apache.groovy.ginq.dsl.expression.HavingExpression))([HavingExpression](expression/havingexpression) havingExpression)` \| \| \| `public R` \| `[visitJoinExpression](#visitJoinExpression(org.apache.groovy.ginq.dsl.expression.JoinExpression))([JoinExpression](expression/joinexpression) joinExpression)` \| \| \| `public R` \| `[visitLimitExpression](#visitLimitExpression(org.apache.groovy.ginq.dsl.expression.LimitExpression))([LimitExpression](expression/limitexpression) limitExpression)` \| \| \| `public R` \| `[visitOnExpression](#visitOnExpression(org.apache.groovy.ginq.dsl.expression.OnExpression))([OnExpression](expression/onexpression) onExpression)` \| \| \| `public R` \| `[visitOrderExpression](#visitOrderExpression(org.apache.groovy.ginq.dsl.expression.OrderExpression))([OrderExpression](expression/orderexpression) orderExpression)` \| \| \| `public R` \| `[visitSelectExpression](#visitSelectExpression(org.apache.groovy.ginq.dsl.expression.SelectExpression))([SelectExpression](expression/selectexpression) selectExpression)` \| \| \| `public R` \| `[visitShutdownExpression](#visitShutdownExpression(org.apache.groovy.ginq.dsl.expression.ShutdownExpression))([ShutdownExpression](expression/shutdownexpression) shutdownExpression)` \| \| \| `public R` \| `[visitWhereExpression](#visitWhereExpression(org.apache.groovy.ginq.dsl.expression.WhereExpression))([WhereExpression](expression/whereexpression) whereExpression)` \| Method Detail ------------- ### public [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> getConfiguration() ### public void setConfiguration([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> configuration) ### public R visit([AbstractGinqExpression](expression/abstractginqexpression) expression) ### public R visitFromExpression([FromExpression](expression/fromexpression) fromExpression) ### public R visitGinqExpression([GinqExpression](expression/ginqexpression) ginqExpression) ### public R visitGroupExpression([GroupExpression](expression/groupexpression) groupExpression) ### public R visitHavingExpression([HavingExpression](expression/havingexpression) havingExpression) ### public R visitJoinExpression([JoinExpression](expression/joinexpression) joinExpression) ### public R visitLimitExpression([LimitExpression](expression/limitexpression) limitExpression) ### public R visitOnExpression([OnExpression](expression/onexpression) onExpression) ### public R visitOrderExpression([OrderExpression](expression/orderexpression) orderExpression) ### public R visitSelectExpression([SelectExpression](expression/selectexpression) selectExpression) ### public R visitShutdownExpression([ShutdownExpression](expression/shutdownexpression) shutdownExpression) ### public R visitWhereExpression([WhereExpression](expression/whereexpression) whereExpression) groovy [Java] Class GinqAstBuilder [Java] Class GinqAstBuilder =========================== * org.apache.groovy.ginq.dsl.GinqAstBuilder All Implemented Interfaces and Traits: [SyntaxErrorReportable](syntaxerrorreportable) ``` public class GinqAstBuilder extends [CodeVisitorSupport](../../../../codehaus/groovy/ast/codevisitorsupport) implements [SyntaxErrorReportable](syntaxerrorreportable) ``` Build the AST for GINQ Since: 4.0.0 Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[GINQ\_SELECT\_DISTINCT](#GINQ_SELECT_DISTINCT)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[ROOT\_GINQ\_EXPRESSION](#ROOT_GINQ_EXPRESSION)` \| \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[GinqAstBuilder](#GinqAstBuilder(org.codehaus.groovy.control.SourceUnit))([SourceUnit](../../../../codehaus/groovy/control/sourceunit) sourceUnit)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [AbstractGinqExpression](expression/abstractginqexpression)` \| `[buildAST](#buildAST(org.codehaus.groovy.ast.ASTNode))([ASTNode](../../../../codehaus/groovy/ast/astnode) astNode)` \| \| \| `public [SourceUnit](../../../../codehaus/groovy/control/sourceunit)` \| `[getSourceUnit](#getSourceUnit())()` \| \| \| `public void` \| `[visitArgumentlistExpression](#visitArgumentlistExpression(org.codehaus.groovy.ast.expr.ArgumentListExpression))([ArgumentListExpression](../../../../codehaus/groovy/ast/expr/argumentlistexpression) expression)` \| \| \| `public void` \| `[visitBinaryExpression](#visitBinaryExpression(org.codehaus.groovy.ast.expr.BinaryExpression))([BinaryExpression](../../../../codehaus/groovy/ast/expr/binaryexpression) expression)` \| \| \| `public void` \| `[visitCastExpression](#visitCastExpression(org.codehaus.groovy.ast.expr.CastExpression))([CastExpression](../../../../codehaus/groovy/ast/expr/castexpression) expression)` \| \| \| `public void` \| `[visitDeclarationExpression](#visitDeclarationExpression(org.codehaus.groovy.ast.expr.DeclarationExpression))([DeclarationExpression](../../../../codehaus/groovy/ast/expr/declarationexpression) expression)` \| \| \| `public void` \| `[visitMethodCallExpression](#visitMethodCallExpression(org.codehaus.groovy.ast.expr.MethodCallExpression))([MethodCallExpression](../../../../codehaus/groovy/ast/expr/methodcallexpression) call)` \| \| \| `public void` \| `[visitMethodCallExpression](#visitMethodCallExpression(org.codehaus.groovy.ast.expr.MethodCallExpression))([MethodCallExpression](../../../../codehaus/groovy/ast/expr/methodcallexpression) call)` \| \| \| `public void` \| `[visitPropertyExpression](#visitPropertyExpression(org.codehaus.groovy.ast.expr.PropertyExpression))([PropertyExpression](../../../../codehaus/groovy/ast/expr/propertyexpression) expression)` \| \| \| `public void` \| `[visitVariableExpression](#visitVariableExpression(org.codehaus.groovy.ast.expr.VariableExpression))([VariableExpression](../../../../codehaus/groovy/ast/expr/variableexpression) expression)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [CodeVisitorSupport](../../../../codehaus/groovy/ast/codevisitorsupport)` \| `[afterSwitchConditionExpressionVisited](../../../../codehaus/groovy/ast/codevisitorsupport#afterSwitchConditionExpressionVisited(org.codehaus.groovy.ast.stmt.SwitchStatement)), [visitArgumentlistExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitArgumentlistExpression(org.codehaus.groovy.ast.expr.ArgumentListExpression)), [visitArrayExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitArrayExpression(org.codehaus.groovy.ast.expr.ArrayExpression)), [visitAssertStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitAssertStatement(org.codehaus.groovy.ast.stmt.AssertStatement)), [visitAttributeExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitAttributeExpression(org.codehaus.groovy.ast.expr.AttributeExpression)), [visitBinaryExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitBinaryExpression(org.codehaus.groovy.ast.expr.BinaryExpression)), [visitBitwiseNegationExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitBitwiseNegationExpression(org.codehaus.groovy.ast.expr.BitwiseNegationExpression)), [visitBlockStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitBlockStatement(org.codehaus.groovy.ast.stmt.BlockStatement)), [visitBooleanExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitBooleanExpression(org.codehaus.groovy.ast.expr.BooleanExpression)), [visitBreakStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitBreakStatement(org.codehaus.groovy.ast.stmt.BreakStatement)), [visitBytecodeExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitBytecodeExpression(org.codehaus.groovy.classgen.BytecodeExpression)), [visitCaseStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitCaseStatement(org.codehaus.groovy.ast.stmt.CaseStatement)), [visitCastExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitCastExpression(org.codehaus.groovy.ast.expr.CastExpression)), [visitCatchStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitCatchStatement(org.codehaus.groovy.ast.stmt.CatchStatement)), [visitClassExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitClassExpression(org.codehaus.groovy.ast.expr.ClassExpression)), [visitClosureExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitClosureExpression(org.codehaus.groovy.ast.expr.ClosureExpression)), [visitClosureListExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitClosureListExpression(org.codehaus.groovy.ast.expr.ClosureListExpression)), [visitConstantExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitConstantExpression(org.codehaus.groovy.ast.expr.ConstantExpression)), [visitConstructorCallExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitConstructorCallExpression(org.codehaus.groovy.ast.expr.ConstructorCallExpression)), [visitContinueStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitContinueStatement(org.codehaus.groovy.ast.stmt.ContinueStatement)), [visitDeclarationExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitDeclarationExpression(org.codehaus.groovy.ast.expr.DeclarationExpression)), [visitDoWhileLoop](../../../../codehaus/groovy/ast/codevisitorsupport#visitDoWhileLoop(org.codehaus.groovy.ast.stmt.DoWhileStatement)), [visitEmptyStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitEmptyStatement(org.codehaus.groovy.ast.stmt.EmptyStatement)), [visitExpressionStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitExpressionStatement(org.codehaus.groovy.ast.stmt.ExpressionStatement)), [visitFieldExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitFieldExpression(org.codehaus.groovy.ast.expr.FieldExpression)), [visitForLoop](../../../../codehaus/groovy/ast/codevisitorsupport#visitForLoop(org.codehaus.groovy.ast.stmt.ForStatement)), [visitGStringExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitGStringExpression(org.codehaus.groovy.ast.expr.GStringExpression)), [visitIfElse](../../../../codehaus/groovy/ast/codevisitorsupport#visitIfElse(org.codehaus.groovy.ast.stmt.IfStatement)), [visitLambdaExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitLambdaExpression(org.codehaus.groovy.ast.expr.LambdaExpression)), [visitListExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitListExpression(org.codehaus.groovy.ast.expr.ListExpression)), [visitMapEntryExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitMapEntryExpression(org.codehaus.groovy.ast.expr.MapEntryExpression)), [visitMapExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitMapExpression(org.codehaus.groovy.ast.expr.MapExpression)), [visitMethodCallExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitMethodCallExpression(org.codehaus.groovy.ast.expr.MethodCallExpression)), [visitMethodPointerExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitMethodPointerExpression(org.codehaus.groovy.ast.expr.MethodPointerExpression)), [visitMethodReferenceExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitMethodReferenceExpression(org.codehaus.groovy.ast.expr.MethodReferenceExpression)), [visitNotExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitNotExpression(org.codehaus.groovy.ast.expr.NotExpression)), [visitPostfixExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitPostfixExpression(org.codehaus.groovy.ast.expr.PostfixExpression)), [visitPrefixExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitPrefixExpression(org.codehaus.groovy.ast.expr.PrefixExpression)), [visitPropertyExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitPropertyExpression(org.codehaus.groovy.ast.expr.PropertyExpression)), [visitRangeExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitRangeExpression(org.codehaus.groovy.ast.expr.RangeExpression)), [visitReturnStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitReturnStatement(org.codehaus.groovy.ast.stmt.ReturnStatement)), [visitShortTernaryExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitShortTernaryExpression(org.codehaus.groovy.ast.expr.ElvisOperatorExpression)), [visitSpreadExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitSpreadExpression(org.codehaus.groovy.ast.expr.SpreadExpression)), [visitSpreadMapExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitSpreadMapExpression(org.codehaus.groovy.ast.expr.SpreadMapExpression)), [visitStaticMethodCallExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitStaticMethodCallExpression(org.codehaus.groovy.ast.expr.StaticMethodCallExpression)), [visitSwitch](../../../../codehaus/groovy/ast/codevisitorsupport#visitSwitch(org.codehaus.groovy.ast.stmt.SwitchStatement)), [visitSynchronizedStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitSynchronizedStatement(org.codehaus.groovy.ast.stmt.SynchronizedStatement)), [visitTernaryExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitTernaryExpression(org.codehaus.groovy.ast.expr.TernaryExpression)), [visitThrowStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitThrowStatement(org.codehaus.groovy.ast.stmt.ThrowStatement)), [visitTryCatchFinally](../../../../codehaus/groovy/ast/codevisitorsupport#visitTryCatchFinally(org.codehaus.groovy.ast.stmt.TryCatchStatement)), [visitTupleExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitTupleExpression(org.codehaus.groovy.ast.expr.TupleExpression)), [visitUnaryMinusExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitUnaryMinusExpression(org.codehaus.groovy.ast.expr.UnaryMinusExpression)), [visitUnaryPlusExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitUnaryPlusExpression(org.codehaus.groovy.ast.expr.UnaryPlusExpression)), [visitVariableExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitVariableExpression(org.codehaus.groovy.ast.expr.VariableExpression)), [visitWhileLoop](../../../../codehaus/groovy/ast/codevisitorsupport#visitWhileLoop(org.codehaus.groovy.ast.stmt.WhileStatement))` \| Field Detail ------------ ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") GINQ\_SELECT\_DISTINCT ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") ROOT\_GINQ\_EXPRESSION Constructor Detail ------------------ ### public GinqAstBuilder([SourceUnit](../../../../codehaus/groovy/control/sourceunit) sourceUnit) Method Detail ------------- ### public [AbstractGinqExpression](expression/abstractginqexpression) buildAST([ASTNode](../../../../codehaus/groovy/ast/astnode) astNode) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [SourceUnit](../../../../codehaus/groovy/control/sourceunit) getSourceUnit() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void visitArgumentlistExpression([ArgumentListExpression](../../../../codehaus/groovy/ast/expr/argumentlistexpression) expression) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void visitBinaryExpression([BinaryExpression](../../../../codehaus/groovy/ast/expr/binaryexpression) expression) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void visitCastExpression([CastExpression](../../../../codehaus/groovy/ast/expr/castexpression) expression) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void visitDeclarationExpression([DeclarationExpression](../../../../codehaus/groovy/ast/expr/declarationexpression) expression) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void visitMethodCallExpression([MethodCallExpression](../../../../codehaus/groovy/ast/expr/methodcallexpression) call) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void visitMethodCallExpression([MethodCallExpression](../../../../codehaus/groovy/ast/expr/methodcallexpression) call) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void visitPropertyExpression([PropertyExpression](../../../../codehaus/groovy/ast/expr/propertyexpression) expression) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void visitVariableExpression([VariableExpression](../../../../codehaus/groovy/ast/expr/variableexpression) expression)	programming_docs
groovy [Groovy] Class GinqAstOptimizer.1 [Groovy] Class GinqAstOptimizer.1 ================================= * org.apache.groovy.ginq.dsl.GinqAstOptimizer.1 ``` class GinqAstOptimizer.1 extends [GinqAstBaseVisitor](ginqastbasevisitor) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[GinqAstOptimizer.1](#GinqAstOptimizer.1())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `void` \| `[visitBinaryExpression](#visitBinaryExpression(org.codehaus.groovy.ast.expr.BinaryExpression))([BinaryExpression](../../../../codehaus/groovy/ast/expr/binaryexpression) expression)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [GinqAstBaseVisitor](ginqastbasevisitor)` \| `[visit](ginqastbasevisitor#visit(org.apache.groovy.ginq.dsl.expression.AbstractGinqExpression)), [visitFromExpression](ginqastbasevisitor#visitFromExpression(org.apache.groovy.ginq.dsl.expression.FromExpression)), [visitGinqExpression](ginqastbasevisitor#visitGinqExpression(org.apache.groovy.ginq.dsl.expression.GinqExpression)), [visitGroupExpression](ginqastbasevisitor#visitGroupExpression(org.apache.groovy.ginq.dsl.expression.GroupExpression)), [visitHavingExpression](ginqastbasevisitor#visitHavingExpression(org.apache.groovy.ginq.dsl.expression.HavingExpression)), [visitJoinExpression](ginqastbasevisitor#visitJoinExpression(org.apache.groovy.ginq.dsl.expression.JoinExpression)), [visitLimitExpression](ginqastbasevisitor#visitLimitExpression(org.apache.groovy.ginq.dsl.expression.LimitExpression)), [visitOnExpression](ginqastbasevisitor#visitOnExpression(org.apache.groovy.ginq.dsl.expression.OnExpression)), [visitOrderExpression](ginqastbasevisitor#visitOrderExpression(org.apache.groovy.ginq.dsl.expression.OrderExpression)), [visitSelectExpression](ginqastbasevisitor#visitSelectExpression(org.apache.groovy.ginq.dsl.expression.SelectExpression)), [visitShutdownExpression](ginqastbasevisitor#visitShutdownExpression(org.apache.groovy.ginq.dsl.expression.ShutdownExpression)), [visitWhereExpression](ginqastbasevisitor#visitWhereExpression(org.apache.groovy.ginq.dsl.expression.WhereExpression))` \| \| `class [CodeVisitorSupport](../../../../codehaus/groovy/ast/codevisitorsupport)` \| `[afterSwitchConditionExpressionVisited](../../../../codehaus/groovy/ast/codevisitorsupport#afterSwitchConditionExpressionVisited(org.codehaus.groovy.ast.stmt.SwitchStatement)), [visitArgumentlistExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitArgumentlistExpression(org.codehaus.groovy.ast.expr.ArgumentListExpression)), [visitArrayExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitArrayExpression(org.codehaus.groovy.ast.expr.ArrayExpression)), [visitAssertStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitAssertStatement(org.codehaus.groovy.ast.stmt.AssertStatement)), [visitAttributeExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitAttributeExpression(org.codehaus.groovy.ast.expr.AttributeExpression)), [visitBinaryExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitBinaryExpression(org.codehaus.groovy.ast.expr.BinaryExpression)), [visitBitwiseNegationExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitBitwiseNegationExpression(org.codehaus.groovy.ast.expr.BitwiseNegationExpression)), [visitBlockStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitBlockStatement(org.codehaus.groovy.ast.stmt.BlockStatement)), [visitBooleanExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitBooleanExpression(org.codehaus.groovy.ast.expr.BooleanExpression)), [visitBreakStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitBreakStatement(org.codehaus.groovy.ast.stmt.BreakStatement)), [visitBytecodeExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitBytecodeExpression(org.codehaus.groovy.classgen.BytecodeExpression)), [visitCaseStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitCaseStatement(org.codehaus.groovy.ast.stmt.CaseStatement)), [visitCastExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitCastExpression(org.codehaus.groovy.ast.expr.CastExpression)), [visitCatchStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitCatchStatement(org.codehaus.groovy.ast.stmt.CatchStatement)), [visitClassExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitClassExpression(org.codehaus.groovy.ast.expr.ClassExpression)), [visitClosureExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitClosureExpression(org.codehaus.groovy.ast.expr.ClosureExpression)), [visitClosureListExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitClosureListExpression(org.codehaus.groovy.ast.expr.ClosureListExpression)), [visitConstantExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitConstantExpression(org.codehaus.groovy.ast.expr.ConstantExpression)), [visitConstructorCallExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitConstructorCallExpression(org.codehaus.groovy.ast.expr.ConstructorCallExpression)), [visitContinueStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitContinueStatement(org.codehaus.groovy.ast.stmt.ContinueStatement)), [visitDeclarationExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitDeclarationExpression(org.codehaus.groovy.ast.expr.DeclarationExpression)), [visitDoWhileLoop](../../../../codehaus/groovy/ast/codevisitorsupport#visitDoWhileLoop(org.codehaus.groovy.ast.stmt.DoWhileStatement)), [visitEmptyStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitEmptyStatement(org.codehaus.groovy.ast.stmt.EmptyStatement)), [visitExpressionStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitExpressionStatement(org.codehaus.groovy.ast.stmt.ExpressionStatement)), [visitFieldExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitFieldExpression(org.codehaus.groovy.ast.expr.FieldExpression)), [visitForLoop](../../../../codehaus/groovy/ast/codevisitorsupport#visitForLoop(org.codehaus.groovy.ast.stmt.ForStatement)), [visitGStringExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitGStringExpression(org.codehaus.groovy.ast.expr.GStringExpression)), [visitIfElse](../../../../codehaus/groovy/ast/codevisitorsupport#visitIfElse(org.codehaus.groovy.ast.stmt.IfStatement)), [visitLambdaExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitLambdaExpression(org.codehaus.groovy.ast.expr.LambdaExpression)), [visitListExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitListExpression(org.codehaus.groovy.ast.expr.ListExpression)), [visitMapEntryExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitMapEntryExpression(org.codehaus.groovy.ast.expr.MapEntryExpression)), [visitMapExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitMapExpression(org.codehaus.groovy.ast.expr.MapExpression)), [visitMethodCallExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitMethodCallExpression(org.codehaus.groovy.ast.expr.MethodCallExpression)), [visitMethodPointerExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitMethodPointerExpression(org.codehaus.groovy.ast.expr.MethodPointerExpression)), [visitMethodReferenceExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitMethodReferenceExpression(org.codehaus.groovy.ast.expr.MethodReferenceExpression)), [visitNotExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitNotExpression(org.codehaus.groovy.ast.expr.NotExpression)), [visitPostfixExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitPostfixExpression(org.codehaus.groovy.ast.expr.PostfixExpression)), [visitPrefixExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitPrefixExpression(org.codehaus.groovy.ast.expr.PrefixExpression)), [visitPropertyExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitPropertyExpression(org.codehaus.groovy.ast.expr.PropertyExpression)), [visitRangeExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitRangeExpression(org.codehaus.groovy.ast.expr.RangeExpression)), [visitReturnStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitReturnStatement(org.codehaus.groovy.ast.stmt.ReturnStatement)), [visitShortTernaryExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitShortTernaryExpression(org.codehaus.groovy.ast.expr.ElvisOperatorExpression)), [visitSpreadExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitSpreadExpression(org.codehaus.groovy.ast.expr.SpreadExpression)), [visitSpreadMapExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitSpreadMapExpression(org.codehaus.groovy.ast.expr.SpreadMapExpression)), [visitStaticMethodCallExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitStaticMethodCallExpression(org.codehaus.groovy.ast.expr.StaticMethodCallExpression)), [visitSwitch](../../../../codehaus/groovy/ast/codevisitorsupport#visitSwitch(org.codehaus.groovy.ast.stmt.SwitchStatement)), [visitSynchronizedStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitSynchronizedStatement(org.codehaus.groovy.ast.stmt.SynchronizedStatement)), [visitTernaryExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitTernaryExpression(org.codehaus.groovy.ast.expr.TernaryExpression)), [visitThrowStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitThrowStatement(org.codehaus.groovy.ast.stmt.ThrowStatement)), [visitTryCatchFinally](../../../../codehaus/groovy/ast/codevisitorsupport#visitTryCatchFinally(org.codehaus.groovy.ast.stmt.TryCatchStatement)), [visitTupleExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitTupleExpression(org.codehaus.groovy.ast.expr.TupleExpression)), [visitUnaryMinusExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitUnaryMinusExpression(org.codehaus.groovy.ast.expr.UnaryMinusExpression)), [visitUnaryPlusExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitUnaryPlusExpression(org.codehaus.groovy.ast.expr.UnaryPlusExpression)), [visitVariableExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitVariableExpression(org.codehaus.groovy.ast.expr.VariableExpression)), [visitWhileLoop](../../../../codehaus/groovy/ast/codevisitorsupport#visitWhileLoop(org.codehaus.groovy.ast.stmt.WhileStatement))` \| Constructor Detail ------------------ ### GinqAstOptimizer.1() Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") void visitBinaryExpression([BinaryExpression](../../../../codehaus/groovy/ast/expr/binaryexpression) expression) groovy [Java] Class GinqAstBaseVisitor [Java] Class GinqAstBaseVisitor =============================== * org.apache.groovy.ginq.dsl.GinqAstBaseVisitor All Implemented Interfaces and Traits: [GinqAstVisitor](ginqastvisitor) ``` public class GinqAstBaseVisitor extends [CodeVisitorSupport](../../../../codehaus/groovy/ast/codevisitorsupport) implements [GinqAstVisitor](ginqastvisitor) ``` The default base visitor for GINQ AST Since: 4.0.0 Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [Void](https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html "Void")` \| `[visit](#visit(org.apache.groovy.ginq.dsl.expression.AbstractGinqExpression))([AbstractGinqExpression](expression/abstractginqexpression) expression)` \| \| \| `public [Void](https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html "Void")` \| `[visitFromExpression](#visitFromExpression(org.apache.groovy.ginq.dsl.expression.FromExpression))([FromExpression](expression/fromexpression) fromExpression)` \| \| \| `public [Void](https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html "Void")` \| `[visitGinqExpression](#visitGinqExpression(org.apache.groovy.ginq.dsl.expression.GinqExpression))([GinqExpression](expression/ginqexpression) ginqExpression)` \| \| \| `public [Void](https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html "Void")` \| `[visitGroupExpression](#visitGroupExpression(org.apache.groovy.ginq.dsl.expression.GroupExpression))([GroupExpression](expression/groupexpression) groupExpression)` \| \| \| `public [Void](https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html "Void")` \| `[visitHavingExpression](#visitHavingExpression(org.apache.groovy.ginq.dsl.expression.HavingExpression))([HavingExpression](expression/havingexpression) havingExpression)` \| \| \| `public [Void](https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html "Void")` \| `[visitJoinExpression](#visitJoinExpression(org.apache.groovy.ginq.dsl.expression.JoinExpression))([JoinExpression](expression/joinexpression) joinExpression)` \| \| \| `public [Void](https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html "Void")` \| `[visitLimitExpression](#visitLimitExpression(org.apache.groovy.ginq.dsl.expression.LimitExpression))([LimitExpression](expression/limitexpression) limitExpression)` \| \| \| `public [Void](https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html "Void")` \| `[visitOnExpression](#visitOnExpression(org.apache.groovy.ginq.dsl.expression.OnExpression))([OnExpression](expression/onexpression) onExpression)` \| \| \| `public [Void](https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html "Void")` \| `[visitOrderExpression](#visitOrderExpression(org.apache.groovy.ginq.dsl.expression.OrderExpression))([OrderExpression](expression/orderexpression) orderExpression)` \| \| \| `public [Void](https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html "Void")` \| `[visitSelectExpression](#visitSelectExpression(org.apache.groovy.ginq.dsl.expression.SelectExpression))([SelectExpression](expression/selectexpression) selectExpression)` \| \| \| `public [Void](https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html "Void")` \| `[visitShutdownExpression](#visitShutdownExpression(org.apache.groovy.ginq.dsl.expression.ShutdownExpression))([ShutdownExpression](expression/shutdownexpression) shutdownExpression)` \| \| \| `public [Void](https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html "Void")` \| `[visitWhereExpression](#visitWhereExpression(org.apache.groovy.ginq.dsl.expression.WhereExpression))([WhereExpression](expression/whereexpression) whereExpression)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [CodeVisitorSupport](../../../../codehaus/groovy/ast/codevisitorsupport)` \| `[afterSwitchConditionExpressionVisited](../../../../codehaus/groovy/ast/codevisitorsupport#afterSwitchConditionExpressionVisited(org.codehaus.groovy.ast.stmt.SwitchStatement)), [visitArgumentlistExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitArgumentlistExpression(org.codehaus.groovy.ast.expr.ArgumentListExpression)), [visitArrayExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitArrayExpression(org.codehaus.groovy.ast.expr.ArrayExpression)), [visitAssertStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitAssertStatement(org.codehaus.groovy.ast.stmt.AssertStatement)), [visitAttributeExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitAttributeExpression(org.codehaus.groovy.ast.expr.AttributeExpression)), [visitBinaryExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitBinaryExpression(org.codehaus.groovy.ast.expr.BinaryExpression)), [visitBitwiseNegationExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitBitwiseNegationExpression(org.codehaus.groovy.ast.expr.BitwiseNegationExpression)), [visitBlockStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitBlockStatement(org.codehaus.groovy.ast.stmt.BlockStatement)), [visitBooleanExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitBooleanExpression(org.codehaus.groovy.ast.expr.BooleanExpression)), [visitBreakStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitBreakStatement(org.codehaus.groovy.ast.stmt.BreakStatement)), [visitBytecodeExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitBytecodeExpression(org.codehaus.groovy.classgen.BytecodeExpression)), [visitCaseStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitCaseStatement(org.codehaus.groovy.ast.stmt.CaseStatement)), [visitCastExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitCastExpression(org.codehaus.groovy.ast.expr.CastExpression)), [visitCatchStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitCatchStatement(org.codehaus.groovy.ast.stmt.CatchStatement)), [visitClassExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitClassExpression(org.codehaus.groovy.ast.expr.ClassExpression)), [visitClosureExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitClosureExpression(org.codehaus.groovy.ast.expr.ClosureExpression)), [visitClosureListExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitClosureListExpression(org.codehaus.groovy.ast.expr.ClosureListExpression)), [visitConstantExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitConstantExpression(org.codehaus.groovy.ast.expr.ConstantExpression)), [visitConstructorCallExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitConstructorCallExpression(org.codehaus.groovy.ast.expr.ConstructorCallExpression)), [visitContinueStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitContinueStatement(org.codehaus.groovy.ast.stmt.ContinueStatement)), [visitDeclarationExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitDeclarationExpression(org.codehaus.groovy.ast.expr.DeclarationExpression)), [visitDoWhileLoop](../../../../codehaus/groovy/ast/codevisitorsupport#visitDoWhileLoop(org.codehaus.groovy.ast.stmt.DoWhileStatement)), [visitEmptyStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitEmptyStatement(org.codehaus.groovy.ast.stmt.EmptyStatement)), [visitExpressionStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitExpressionStatement(org.codehaus.groovy.ast.stmt.ExpressionStatement)), [visitFieldExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitFieldExpression(org.codehaus.groovy.ast.expr.FieldExpression)), [visitForLoop](../../../../codehaus/groovy/ast/codevisitorsupport#visitForLoop(org.codehaus.groovy.ast.stmt.ForStatement)), [visitGStringExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitGStringExpression(org.codehaus.groovy.ast.expr.GStringExpression)), [visitIfElse](../../../../codehaus/groovy/ast/codevisitorsupport#visitIfElse(org.codehaus.groovy.ast.stmt.IfStatement)), [visitLambdaExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitLambdaExpression(org.codehaus.groovy.ast.expr.LambdaExpression)), [visitListExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitListExpression(org.codehaus.groovy.ast.expr.ListExpression)), [visitMapEntryExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitMapEntryExpression(org.codehaus.groovy.ast.expr.MapEntryExpression)), [visitMapExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitMapExpression(org.codehaus.groovy.ast.expr.MapExpression)), [visitMethodCallExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitMethodCallExpression(org.codehaus.groovy.ast.expr.MethodCallExpression)), [visitMethodPointerExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitMethodPointerExpression(org.codehaus.groovy.ast.expr.MethodPointerExpression)), [visitMethodReferenceExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitMethodReferenceExpression(org.codehaus.groovy.ast.expr.MethodReferenceExpression)), [visitNotExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitNotExpression(org.codehaus.groovy.ast.expr.NotExpression)), [visitPostfixExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitPostfixExpression(org.codehaus.groovy.ast.expr.PostfixExpression)), [visitPrefixExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitPrefixExpression(org.codehaus.groovy.ast.expr.PrefixExpression)), [visitPropertyExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitPropertyExpression(org.codehaus.groovy.ast.expr.PropertyExpression)), [visitRangeExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitRangeExpression(org.codehaus.groovy.ast.expr.RangeExpression)), [visitReturnStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitReturnStatement(org.codehaus.groovy.ast.stmt.ReturnStatement)), [visitShortTernaryExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitShortTernaryExpression(org.codehaus.groovy.ast.expr.ElvisOperatorExpression)), [visitSpreadExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitSpreadExpression(org.codehaus.groovy.ast.expr.SpreadExpression)), [visitSpreadMapExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitSpreadMapExpression(org.codehaus.groovy.ast.expr.SpreadMapExpression)), [visitStaticMethodCallExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitStaticMethodCallExpression(org.codehaus.groovy.ast.expr.StaticMethodCallExpression)), [visitSwitch](../../../../codehaus/groovy/ast/codevisitorsupport#visitSwitch(org.codehaus.groovy.ast.stmt.SwitchStatement)), [visitSynchronizedStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitSynchronizedStatement(org.codehaus.groovy.ast.stmt.SynchronizedStatement)), [visitTernaryExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitTernaryExpression(org.codehaus.groovy.ast.expr.TernaryExpression)), [visitThrowStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitThrowStatement(org.codehaus.groovy.ast.stmt.ThrowStatement)), [visitTryCatchFinally](../../../../codehaus/groovy/ast/codevisitorsupport#visitTryCatchFinally(org.codehaus.groovy.ast.stmt.TryCatchStatement)), [visitTupleExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitTupleExpression(org.codehaus.groovy.ast.expr.TupleExpression)), [visitUnaryMinusExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitUnaryMinusExpression(org.codehaus.groovy.ast.expr.UnaryMinusExpression)), [visitUnaryPlusExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitUnaryPlusExpression(org.codehaus.groovy.ast.expr.UnaryPlusExpression)), [visitVariableExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitVariableExpression(org.codehaus.groovy.ast.expr.VariableExpression)), [visitWhileLoop](../../../../codehaus/groovy/ast/codevisitorsupport#visitWhileLoop(org.codehaus.groovy.ast.stmt.WhileStatement))` \| Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Void](https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html "Void") visit([AbstractGinqExpression](expression/abstractginqexpression) expression) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Void](https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html "Void") visitFromExpression([FromExpression](expression/fromexpression) fromExpression) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Void](https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html "Void") visitGinqExpression([GinqExpression](expression/ginqexpression) ginqExpression) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Void](https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html "Void") visitGroupExpression([GroupExpression](expression/groupexpression) groupExpression) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Void](https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html "Void") visitHavingExpression([HavingExpression](expression/havingexpression) havingExpression) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Void](https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html "Void") visitJoinExpression([JoinExpression](expression/joinexpression) joinExpression) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Void](https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html "Void") visitLimitExpression([LimitExpression](expression/limitexpression) limitExpression) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Void](https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html "Void") visitOnExpression([OnExpression](expression/onexpression) onExpression) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Void](https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html "Void") visitOrderExpression([OrderExpression](expression/orderexpression) orderExpression) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Void](https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html "Void") visitSelectExpression([SelectExpression](expression/selectexpression) selectExpression) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Void](https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html "Void") visitShutdownExpression([ShutdownExpression](expression/shutdownexpression) shutdownExpression) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Void](https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html "Void") visitWhereExpression([WhereExpression](expression/whereexpression) whereExpression)	programming_docs
groovy [Groovy] Class GinqAstOptimizer [Groovy] Class GinqAstOptimizer =============================== * org.apache.groovy.ginq.dsl.GinqAstOptimizer ``` @[CompileStatic](../../../../../groovy/transform/compilestatic "CompileStatic") class GinqAstOptimizer extends [GinqAstBaseVisitor](ginqastbasevisitor) ``` Optimize the execution plan of GINQ through transforming AST. Note:The optimizer only optimizes the AST for inner/left joins for now, e.g. ``` from n1 in nums1 innerjoin n2 in nums2 on n1 == n2 where n1 > 1 && n2 <= 3 select n1, n2 ``` will be optimized to ``` from n1 in ( from alias86329782 in nums1 where alias86329782 > 1 select alias86329782 ) innerjoin n2 in ( from alias23802906 in nums2 where alias23802906 <= 3 select alias23802906 ) on n1 == n2 select n1, n2 ``` Since: 4.0.0 Nested Class Summary -------------------- Nested classes \| Modifiers \| Name \| Description \| \| `class` \| `[GinqAstOptimizer.1](ginqastoptimizer.1)` \| \| \| `class` \| `[GinqAstOptimizer.2](ginqastoptimizer.2)` \| \| \| `class` \| `[GinqAstOptimizer.3](ginqastoptimizer.3)` \| \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[GinqAstOptimizer](#GinqAstOptimizer())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Void](https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html "Void")` \| `[visitGinqExpression](#visitGinqExpression(org.apache.groovy.ginq.dsl.expression.GinqExpression))([GinqExpression](expression/ginqexpression) ginqExpression)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [GinqAstBaseVisitor](ginqastbasevisitor)` \| `[visit](ginqastbasevisitor#visit(org.apache.groovy.ginq.dsl.expression.AbstractGinqExpression)), [visitFromExpression](ginqastbasevisitor#visitFromExpression(org.apache.groovy.ginq.dsl.expression.FromExpression)), [visitGinqExpression](ginqastbasevisitor#visitGinqExpression(org.apache.groovy.ginq.dsl.expression.GinqExpression)), [visitGroupExpression](ginqastbasevisitor#visitGroupExpression(org.apache.groovy.ginq.dsl.expression.GroupExpression)), [visitHavingExpression](ginqastbasevisitor#visitHavingExpression(org.apache.groovy.ginq.dsl.expression.HavingExpression)), [visitJoinExpression](ginqastbasevisitor#visitJoinExpression(org.apache.groovy.ginq.dsl.expression.JoinExpression)), [visitLimitExpression](ginqastbasevisitor#visitLimitExpression(org.apache.groovy.ginq.dsl.expression.LimitExpression)), [visitOnExpression](ginqastbasevisitor#visitOnExpression(org.apache.groovy.ginq.dsl.expression.OnExpression)), [visitOrderExpression](ginqastbasevisitor#visitOrderExpression(org.apache.groovy.ginq.dsl.expression.OrderExpression)), [visitSelectExpression](ginqastbasevisitor#visitSelectExpression(org.apache.groovy.ginq.dsl.expression.SelectExpression)), [visitShutdownExpression](ginqastbasevisitor#visitShutdownExpression(org.apache.groovy.ginq.dsl.expression.ShutdownExpression)), [visitWhereExpression](ginqastbasevisitor#visitWhereExpression(org.apache.groovy.ginq.dsl.expression.WhereExpression))` \| \| `class [CodeVisitorSupport](../../../../codehaus/groovy/ast/codevisitorsupport)` \| `[afterSwitchConditionExpressionVisited](../../../../codehaus/groovy/ast/codevisitorsupport#afterSwitchConditionExpressionVisited(org.codehaus.groovy.ast.stmt.SwitchStatement)), [visitArgumentlistExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitArgumentlistExpression(org.codehaus.groovy.ast.expr.ArgumentListExpression)), [visitArrayExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitArrayExpression(org.codehaus.groovy.ast.expr.ArrayExpression)), [visitAssertStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitAssertStatement(org.codehaus.groovy.ast.stmt.AssertStatement)), [visitAttributeExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitAttributeExpression(org.codehaus.groovy.ast.expr.AttributeExpression)), [visitBinaryExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitBinaryExpression(org.codehaus.groovy.ast.expr.BinaryExpression)), [visitBitwiseNegationExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitBitwiseNegationExpression(org.codehaus.groovy.ast.expr.BitwiseNegationExpression)), [visitBlockStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitBlockStatement(org.codehaus.groovy.ast.stmt.BlockStatement)), [visitBooleanExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitBooleanExpression(org.codehaus.groovy.ast.expr.BooleanExpression)), [visitBreakStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitBreakStatement(org.codehaus.groovy.ast.stmt.BreakStatement)), [visitBytecodeExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitBytecodeExpression(org.codehaus.groovy.classgen.BytecodeExpression)), [visitCaseStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitCaseStatement(org.codehaus.groovy.ast.stmt.CaseStatement)), [visitCastExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitCastExpression(org.codehaus.groovy.ast.expr.CastExpression)), [visitCatchStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitCatchStatement(org.codehaus.groovy.ast.stmt.CatchStatement)), [visitClassExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitClassExpression(org.codehaus.groovy.ast.expr.ClassExpression)), [visitClosureExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitClosureExpression(org.codehaus.groovy.ast.expr.ClosureExpression)), [visitClosureListExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitClosureListExpression(org.codehaus.groovy.ast.expr.ClosureListExpression)), [visitConstantExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitConstantExpression(org.codehaus.groovy.ast.expr.ConstantExpression)), [visitConstructorCallExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitConstructorCallExpression(org.codehaus.groovy.ast.expr.ConstructorCallExpression)), [visitContinueStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitContinueStatement(org.codehaus.groovy.ast.stmt.ContinueStatement)), [visitDeclarationExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitDeclarationExpression(org.codehaus.groovy.ast.expr.DeclarationExpression)), [visitDoWhileLoop](../../../../codehaus/groovy/ast/codevisitorsupport#visitDoWhileLoop(org.codehaus.groovy.ast.stmt.DoWhileStatement)), [visitEmptyStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitEmptyStatement(org.codehaus.groovy.ast.stmt.EmptyStatement)), [visitExpressionStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitExpressionStatement(org.codehaus.groovy.ast.stmt.ExpressionStatement)), [visitFieldExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitFieldExpression(org.codehaus.groovy.ast.expr.FieldExpression)), [visitForLoop](../../../../codehaus/groovy/ast/codevisitorsupport#visitForLoop(org.codehaus.groovy.ast.stmt.ForStatement)), [visitGStringExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitGStringExpression(org.codehaus.groovy.ast.expr.GStringExpression)), [visitIfElse](../../../../codehaus/groovy/ast/codevisitorsupport#visitIfElse(org.codehaus.groovy.ast.stmt.IfStatement)), [visitLambdaExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitLambdaExpression(org.codehaus.groovy.ast.expr.LambdaExpression)), [visitListExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitListExpression(org.codehaus.groovy.ast.expr.ListExpression)), [visitMapEntryExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitMapEntryExpression(org.codehaus.groovy.ast.expr.MapEntryExpression)), [visitMapExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitMapExpression(org.codehaus.groovy.ast.expr.MapExpression)), [visitMethodCallExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitMethodCallExpression(org.codehaus.groovy.ast.expr.MethodCallExpression)), [visitMethodPointerExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitMethodPointerExpression(org.codehaus.groovy.ast.expr.MethodPointerExpression)), [visitMethodReferenceExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitMethodReferenceExpression(org.codehaus.groovy.ast.expr.MethodReferenceExpression)), [visitNotExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitNotExpression(org.codehaus.groovy.ast.expr.NotExpression)), [visitPostfixExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitPostfixExpression(org.codehaus.groovy.ast.expr.PostfixExpression)), [visitPrefixExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitPrefixExpression(org.codehaus.groovy.ast.expr.PrefixExpression)), [visitPropertyExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitPropertyExpression(org.codehaus.groovy.ast.expr.PropertyExpression)), [visitRangeExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitRangeExpression(org.codehaus.groovy.ast.expr.RangeExpression)), [visitReturnStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitReturnStatement(org.codehaus.groovy.ast.stmt.ReturnStatement)), [visitShortTernaryExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitShortTernaryExpression(org.codehaus.groovy.ast.expr.ElvisOperatorExpression)), [visitSpreadExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitSpreadExpression(org.codehaus.groovy.ast.expr.SpreadExpression)), [visitSpreadMapExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitSpreadMapExpression(org.codehaus.groovy.ast.expr.SpreadMapExpression)), [visitStaticMethodCallExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitStaticMethodCallExpression(org.codehaus.groovy.ast.expr.StaticMethodCallExpression)), [visitSwitch](../../../../codehaus/groovy/ast/codevisitorsupport#visitSwitch(org.codehaus.groovy.ast.stmt.SwitchStatement)), [visitSynchronizedStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitSynchronizedStatement(org.codehaus.groovy.ast.stmt.SynchronizedStatement)), [visitTernaryExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitTernaryExpression(org.codehaus.groovy.ast.expr.TernaryExpression)), [visitThrowStatement](../../../../codehaus/groovy/ast/codevisitorsupport#visitThrowStatement(org.codehaus.groovy.ast.stmt.ThrowStatement)), [visitTryCatchFinally](../../../../codehaus/groovy/ast/codevisitorsupport#visitTryCatchFinally(org.codehaus.groovy.ast.stmt.TryCatchStatement)), [visitTupleExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitTupleExpression(org.codehaus.groovy.ast.expr.TupleExpression)), [visitUnaryMinusExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitUnaryMinusExpression(org.codehaus.groovy.ast.expr.UnaryMinusExpression)), [visitUnaryPlusExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitUnaryPlusExpression(org.codehaus.groovy.ast.expr.UnaryPlusExpression)), [visitVariableExpression](../../../../codehaus/groovy/ast/codevisitorsupport#visitVariableExpression(org.codehaus.groovy.ast.expr.VariableExpression)), [visitWhileLoop](../../../../codehaus/groovy/ast/codevisitorsupport#visitWhileLoop(org.codehaus.groovy.ast.stmt.WhileStatement))` \| Constructor Detail ------------------ ### GinqAstOptimizer() Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") [Void](https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html "Void") visitGinqExpression([GinqExpression](expression/ginqexpression) ginqExpression) groovy [Java] Class WhereExpression [Java] Class WhereExpression ============================ * org.apache.groovy.ginq.dsl.expression.WhereExpression ``` public class WhereExpression extends [FilterExpression](filterexpression) ``` Represent the where expression Since: 4.0.0 Inherited fields \| Fields inherited from class \| Fields \| \| `class [FilterExpression](filterexpression)` \| `[filterExpr](filterexpression#filterExpr)` \| \| `class [Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[EMPTY\_ARRAY](../../../../../codehaus/groovy/ast/expr/expression#EMPTY_ARRAY)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[WhereExpression](#WhereExpression(org.codehaus.groovy.ast.expr.Expression))([Expression](../../../../../codehaus/groovy/ast/expr/expression) filterExpr)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| `<R>` \| `public R` \| `[accept](#accept(GinqAstVisitor))([GinqAstVisitor](../ginqastvisitor "GinqAstVisitor")<R> visitor)` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getText](#getText())()` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[toString](#toString())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [FilterExpression](filterexpression)` \| `[getFilterExpr](filterexpression#getFilterExpr()), [setFilterExpr](filterexpression#setFilterExpr(org.codehaus.groovy.ast.expr.Expression))` \| \| `class [ProcessExpression](processexpression)` \| `[getDataSourceExpression](processexpression#getDataSourceExpression()), [setDataSourceExpression](processexpression#setDataSourceExpression(org.apache.groovy.ginq.dsl.expression.DataSourceExpression))` \| \| `class [AbstractGinqExpression](abstractginqexpression)` \| `[accept](abstractginqexpression#accept(GinqAstVisitor)), [transformExpression](abstractginqexpression#transformExpression(org.codehaus.groovy.ast.expr.ExpressionTransformer)), [visit](abstractginqexpression#visit(org.codehaus.groovy.ast.GroovyCodeVisitor))` \| \| `class [Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[getType](../../../../../codehaus/groovy/ast/expr/expression#getType()), [setType](../../../../../codehaus/groovy/ast/expr/expression#setType(org.codehaus.groovy.ast.ClassNode)), [transformExpression](../../../../../codehaus/groovy/ast/expr/expression#transformExpression(org.codehaus.groovy.ast.expr.ExpressionTransformer)), [transformExpressions](../../../../../codehaus/groovy/ast/expr/expression#transformExpressions(List,%20org.codehaus.groovy.ast.expr.ExpressionTransformer)), [transformExpressions](../../../../../codehaus/groovy/ast/expr/expression#transformExpressions(List,%20org.codehaus.groovy.ast.expr.ExpressionTransformer,%20Class))` \| \| `class [AnnotatedNode](../../../../../codehaus/groovy/ast/annotatednode)` \| `[addAnnotation](../../../../../codehaus/groovy/ast/annotatednode#addAnnotation(org.codehaus.groovy.ast.AnnotationNode)), [addAnnotations](../../../../../codehaus/groovy/ast/annotatednode#addAnnotations(List)), [getAnnotations](../../../../../codehaus/groovy/ast/annotatednode#getAnnotations()), [getAnnotations](../../../../../codehaus/groovy/ast/annotatednode#getAnnotations(org.codehaus.groovy.ast.ClassNode)), [getDeclaringClass](../../../../../codehaus/groovy/ast/annotatednode#getDeclaringClass()), [getGroovydoc](../../../../../codehaus/groovy/ast/annotatednode#getGroovydoc()), [getInstance](../../../../../codehaus/groovy/ast/annotatednode#getInstance()), [hasNoRealSourcePosition](../../../../../codehaus/groovy/ast/annotatednode#hasNoRealSourcePosition()), [isSynthetic](../../../../../codehaus/groovy/ast/annotatednode#isSynthetic()), [setDeclaringClass](../../../../../codehaus/groovy/ast/annotatednode#setDeclaringClass(org.codehaus.groovy.ast.ClassNode)), [setHasNoRealSourcePosition](../../../../../codehaus/groovy/ast/annotatednode#setHasNoRealSourcePosition(boolean)), [setSynthetic](../../../../../codehaus/groovy/ast/annotatednode#setSynthetic(boolean))` \| \| `class [ASTNode](../../../../../codehaus/groovy/ast/astnode)` \| `[copyNodeMetaData](../../../../../codehaus/groovy/ast/astnode#copyNodeMetaData(org.codehaus.groovy.ast.ASTNode)), [getColumnNumber](../../../../../codehaus/groovy/ast/astnode#getColumnNumber()), [getLastColumnNumber](../../../../../codehaus/groovy/ast/astnode#getLastColumnNumber()), [getLastLineNumber](../../../../../codehaus/groovy/ast/astnode#getLastLineNumber()), [getLineNumber](../../../../../codehaus/groovy/ast/astnode#getLineNumber()), [getMetaDataMap](../../../../../codehaus/groovy/ast/astnode#getMetaDataMap()), [getText](../../../../../codehaus/groovy/ast/astnode#getText()), [setColumnNumber](../../../../../codehaus/groovy/ast/astnode#setColumnNumber(int)), [setLastColumnNumber](../../../../../codehaus/groovy/ast/astnode#setLastColumnNumber(int)), [setLastLineNumber](../../../../../codehaus/groovy/ast/astnode#setLastLineNumber(int)), [setLineNumber](../../../../../codehaus/groovy/ast/astnode#setLineNumber(int)), [setMetaDataMap](../../../../../codehaus/groovy/ast/astnode#setMetaDataMap(Map)), [setSourcePosition](../../../../../codehaus/groovy/ast/astnode#setSourcePosition(org.codehaus.groovy.ast.ASTNode)), [visit](../../../../../codehaus/groovy/ast/astnode#visit(org.codehaus.groovy.ast.GroovyCodeVisitor))` \| Constructor Detail ------------------ ### public WhereExpression([Expression](../../../../../codehaus/groovy/ast/expr/expression) filterExpr) Method Detail ------------- ### <R> @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public R accept([GinqAstVisitor](../ginqastvisitor "GinqAstVisitor")<R> visitor) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getText() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") toString() groovy [Java] Class GroupExpression [Java] Class GroupExpression ============================ * org.apache.groovy.ginq.dsl.expression.GroupExpression ``` public class GroupExpression extends [ProcessExpression](processexpression) ``` Represents group by expression Since: 4.0.0 Inherited fields \| Fields inherited from class \| Fields \| \| `class [Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[EMPTY\_ARRAY](../../../../../codehaus/groovy/ast/expr/expression#EMPTY_ARRAY)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[GroupExpression](#GroupExpression(org.codehaus.groovy.ast.expr.Expression))([Expression](../../../../../codehaus/groovy/ast/expr/expression) classifierExpr)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| `<R>` \| `public R` \| `[accept](#accept(GinqAstVisitor))([GinqAstVisitor](../ginqastvisitor "GinqAstVisitor")<R> visitor)` \| \| \| `public [Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[getClassifierExpr](#getClassifierExpr())()` \| \| \| `public [HavingExpression](havingexpression)` \| `[getHavingExpression](#getHavingExpression())()` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getText](#getText())()` \| \| \| `public void` \| `[setHavingExpression](#setHavingExpression(org.apache.groovy.ginq.dsl.expression.HavingExpression))([HavingExpression](havingexpression) havingExpression)` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[toString](#toString())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [ProcessExpression](processexpression)` \| `[getDataSourceExpression](processexpression#getDataSourceExpression()), [setDataSourceExpression](processexpression#setDataSourceExpression(org.apache.groovy.ginq.dsl.expression.DataSourceExpression))` \| \| `class [AbstractGinqExpression](abstractginqexpression)` \| `[accept](abstractginqexpression#accept(GinqAstVisitor)), [transformExpression](abstractginqexpression#transformExpression(org.codehaus.groovy.ast.expr.ExpressionTransformer)), [visit](abstractginqexpression#visit(org.codehaus.groovy.ast.GroovyCodeVisitor))` \| \| `class [Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[getType](../../../../../codehaus/groovy/ast/expr/expression#getType()), [setType](../../../../../codehaus/groovy/ast/expr/expression#setType(org.codehaus.groovy.ast.ClassNode)), [transformExpression](../../../../../codehaus/groovy/ast/expr/expression#transformExpression(org.codehaus.groovy.ast.expr.ExpressionTransformer)), [transformExpressions](../../../../../codehaus/groovy/ast/expr/expression#transformExpressions(List,%20org.codehaus.groovy.ast.expr.ExpressionTransformer)), [transformExpressions](../../../../../codehaus/groovy/ast/expr/expression#transformExpressions(List,%20org.codehaus.groovy.ast.expr.ExpressionTransformer,%20Class))` \| \| `class [AnnotatedNode](../../../../../codehaus/groovy/ast/annotatednode)` \| `[addAnnotation](../../../../../codehaus/groovy/ast/annotatednode#addAnnotation(org.codehaus.groovy.ast.AnnotationNode)), [addAnnotations](../../../../../codehaus/groovy/ast/annotatednode#addAnnotations(List)), [getAnnotations](../../../../../codehaus/groovy/ast/annotatednode#getAnnotations()), [getAnnotations](../../../../../codehaus/groovy/ast/annotatednode#getAnnotations(org.codehaus.groovy.ast.ClassNode)), [getDeclaringClass](../../../../../codehaus/groovy/ast/annotatednode#getDeclaringClass()), [getGroovydoc](../../../../../codehaus/groovy/ast/annotatednode#getGroovydoc()), [getInstance](../../../../../codehaus/groovy/ast/annotatednode#getInstance()), [hasNoRealSourcePosition](../../../../../codehaus/groovy/ast/annotatednode#hasNoRealSourcePosition()), [isSynthetic](../../../../../codehaus/groovy/ast/annotatednode#isSynthetic()), [setDeclaringClass](../../../../../codehaus/groovy/ast/annotatednode#setDeclaringClass(org.codehaus.groovy.ast.ClassNode)), [setHasNoRealSourcePosition](../../../../../codehaus/groovy/ast/annotatednode#setHasNoRealSourcePosition(boolean)), [setSynthetic](../../../../../codehaus/groovy/ast/annotatednode#setSynthetic(boolean))` \| \| `class [ASTNode](../../../../../codehaus/groovy/ast/astnode)` \| `[copyNodeMetaData](../../../../../codehaus/groovy/ast/astnode#copyNodeMetaData(org.codehaus.groovy.ast.ASTNode)), [getColumnNumber](../../../../../codehaus/groovy/ast/astnode#getColumnNumber()), [getLastColumnNumber](../../../../../codehaus/groovy/ast/astnode#getLastColumnNumber()), [getLastLineNumber](../../../../../codehaus/groovy/ast/astnode#getLastLineNumber()), [getLineNumber](../../../../../codehaus/groovy/ast/astnode#getLineNumber()), [getMetaDataMap](../../../../../codehaus/groovy/ast/astnode#getMetaDataMap()), [getText](../../../../../codehaus/groovy/ast/astnode#getText()), [setColumnNumber](../../../../../codehaus/groovy/ast/astnode#setColumnNumber(int)), [setLastColumnNumber](../../../../../codehaus/groovy/ast/astnode#setLastColumnNumber(int)), [setLastLineNumber](../../../../../codehaus/groovy/ast/astnode#setLastLineNumber(int)), [setLineNumber](../../../../../codehaus/groovy/ast/astnode#setLineNumber(int)), [setMetaDataMap](../../../../../codehaus/groovy/ast/astnode#setMetaDataMap(Map)), [setSourcePosition](../../../../../codehaus/groovy/ast/astnode#setSourcePosition(org.codehaus.groovy.ast.ASTNode)), [visit](../../../../../codehaus/groovy/ast/astnode#visit(org.codehaus.groovy.ast.GroovyCodeVisitor))` \| Constructor Detail ------------------ ### public GroupExpression([Expression](../../../../../codehaus/groovy/ast/expr/expression) classifierExpr) Method Detail ------------- ### <R> @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public R accept([GinqAstVisitor](../ginqastvisitor "GinqAstVisitor")<R> visitor) ### public [Expression](../../../../../codehaus/groovy/ast/expr/expression) getClassifierExpr() ### public [HavingExpression](havingexpression) getHavingExpression() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getText() ### public void setHavingExpression([HavingExpression](havingexpression) havingExpression) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") toString()	programming_docs
groovy [Java] Interface DataSourceHolder [Java] Interface DataSourceHolder ================================= ``` public interface DataSourceHolder ``` Represents data source holder, e.g. from, joins, where, groupby, etc. Since: 4.0.0 Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [DataSourceExpression](datasourceexpression)` \| `[getDataSourceExpression](#getDataSourceExpression())()` \| \| \| `public void` \| `[setDataSourceExpression](#setDataSourceExpression(org.apache.groovy.ginq.dsl.expression.DataSourceExpression))([DataSourceExpression](datasourceexpression) dataSourceExpression)` \| Method Detail ------------- ### public [DataSourceExpression](datasourceexpression) getDataSourceExpression() ### public void setDataSourceExpression([DataSourceExpression](datasourceexpression) dataSourceExpression) groovy [Java] Class FilterExpression [Java] Class FilterExpression ============================= * org.apache.groovy.ginq.dsl.expression.FilterExpression ``` public abstract class FilterExpression extends [ProcessExpression](processexpression) ``` Represents filter expression Since: 4.0.0 Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `protected [Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[filterExpr](#filterExpr)` \| \| Inherited fields \| Fields inherited from class \| Fields \| \| `class [Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[EMPTY\_ARRAY](../../../../../codehaus/groovy/ast/expr/expression#EMPTY_ARRAY)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[FilterExpression](#FilterExpression(org.codehaus.groovy.ast.expr.Expression))([Expression](../../../../../codehaus/groovy/ast/expr/expression) filterExpr)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[getFilterExpr](#getFilterExpr())()` \| \| \| `public void` \| `[setFilterExpr](#setFilterExpr(org.codehaus.groovy.ast.expr.Expression))([Expression](../../../../../codehaus/groovy/ast/expr/expression) filterExpr)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [ProcessExpression](processexpression)` \| `[getDataSourceExpression](processexpression#getDataSourceExpression()), [setDataSourceExpression](processexpression#setDataSourceExpression(org.apache.groovy.ginq.dsl.expression.DataSourceExpression))` \| \| `class [AbstractGinqExpression](abstractginqexpression)` \| `[accept](abstractginqexpression#accept(GinqAstVisitor)), [transformExpression](abstractginqexpression#transformExpression(org.codehaus.groovy.ast.expr.ExpressionTransformer)), [visit](abstractginqexpression#visit(org.codehaus.groovy.ast.GroovyCodeVisitor))` \| \| `class [Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[getType](../../../../../codehaus/groovy/ast/expr/expression#getType()), [setType](../../../../../codehaus/groovy/ast/expr/expression#setType(org.codehaus.groovy.ast.ClassNode)), [transformExpression](../../../../../codehaus/groovy/ast/expr/expression#transformExpression(org.codehaus.groovy.ast.expr.ExpressionTransformer)), [transformExpressions](../../../../../codehaus/groovy/ast/expr/expression#transformExpressions(List,%20org.codehaus.groovy.ast.expr.ExpressionTransformer)), [transformExpressions](../../../../../codehaus/groovy/ast/expr/expression#transformExpressions(List,%20org.codehaus.groovy.ast.expr.ExpressionTransformer,%20Class))` \| \| `class [AnnotatedNode](../../../../../codehaus/groovy/ast/annotatednode)` \| `[addAnnotation](../../../../../codehaus/groovy/ast/annotatednode#addAnnotation(org.codehaus.groovy.ast.AnnotationNode)), [addAnnotations](../../../../../codehaus/groovy/ast/annotatednode#addAnnotations(List)), [getAnnotations](../../../../../codehaus/groovy/ast/annotatednode#getAnnotations()), [getAnnotations](../../../../../codehaus/groovy/ast/annotatednode#getAnnotations(org.codehaus.groovy.ast.ClassNode)), [getDeclaringClass](../../../../../codehaus/groovy/ast/annotatednode#getDeclaringClass()), [getGroovydoc](../../../../../codehaus/groovy/ast/annotatednode#getGroovydoc()), [getInstance](../../../../../codehaus/groovy/ast/annotatednode#getInstance()), [hasNoRealSourcePosition](../../../../../codehaus/groovy/ast/annotatednode#hasNoRealSourcePosition()), [isSynthetic](../../../../../codehaus/groovy/ast/annotatednode#isSynthetic()), [setDeclaringClass](../../../../../codehaus/groovy/ast/annotatednode#setDeclaringClass(org.codehaus.groovy.ast.ClassNode)), [setHasNoRealSourcePosition](../../../../../codehaus/groovy/ast/annotatednode#setHasNoRealSourcePosition(boolean)), [setSynthetic](../../../../../codehaus/groovy/ast/annotatednode#setSynthetic(boolean))` \| \| `class [ASTNode](../../../../../codehaus/groovy/ast/astnode)` \| `[copyNodeMetaData](../../../../../codehaus/groovy/ast/astnode#copyNodeMetaData(org.codehaus.groovy.ast.ASTNode)), [getColumnNumber](../../../../../codehaus/groovy/ast/astnode#getColumnNumber()), [getLastColumnNumber](../../../../../codehaus/groovy/ast/astnode#getLastColumnNumber()), [getLastLineNumber](../../../../../codehaus/groovy/ast/astnode#getLastLineNumber()), [getLineNumber](../../../../../codehaus/groovy/ast/astnode#getLineNumber()), [getMetaDataMap](../../../../../codehaus/groovy/ast/astnode#getMetaDataMap()), [getText](../../../../../codehaus/groovy/ast/astnode#getText()), [setColumnNumber](../../../../../codehaus/groovy/ast/astnode#setColumnNumber(int)), [setLastColumnNumber](../../../../../codehaus/groovy/ast/astnode#setLastColumnNumber(int)), [setLastLineNumber](../../../../../codehaus/groovy/ast/astnode#setLastLineNumber(int)), [setLineNumber](../../../../../codehaus/groovy/ast/astnode#setLineNumber(int)), [setMetaDataMap](../../../../../codehaus/groovy/ast/astnode#setMetaDataMap(Map)), [setSourcePosition](../../../../../codehaus/groovy/ast/astnode#setSourcePosition(org.codehaus.groovy.ast.ASTNode)), [visit](../../../../../codehaus/groovy/ast/astnode#visit(org.codehaus.groovy.ast.GroovyCodeVisitor))` \| Field Detail ------------ ### protected [Expression](../../../../../codehaus/groovy/ast/expr/expression) filterExpr Constructor Detail ------------------ ### public FilterExpression([Expression](../../../../../codehaus/groovy/ast/expr/expression) filterExpr) Method Detail ------------- ### public [Expression](../../../../../codehaus/groovy/ast/expr/expression) getFilterExpr() ### public void setFilterExpr([Expression](../../../../../codehaus/groovy/ast/expr/expression) filterExpr) groovy [Java] Class GinqExpression [Java] Class GinqExpression =========================== * org.apache.groovy.ginq.dsl.expression.GinqExpression ``` public class GinqExpression extends [AbstractGinqExpression](abstractginqexpression) ``` Represents GINQ expression, which has the following structure: ``` ginq \|__ from \|__ [innerjoin/leftjoin/rightjoin/fulljoin/crossjoin]* \| \|__ on \|__ [where] \|__ [groupby] \| \|__ [having] \|__ [orderby] \|__ [limit] \|__ select ``` (Note: [ ] means optional) Since: 4.0.0 Inherited fields \| Fields inherited from class \| Fields \| \| `class [Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[EMPTY\_ARRAY](../../../../../codehaus/groovy/ast/expr/expression#EMPTY_ARRAY)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| `<R>` \| `public R` \| `[accept](#accept(GinqAstVisitor))([GinqAstVisitor](../ginqastvisitor "GinqAstVisitor")<R> visitor)` \| \| \| `public void` \| `[addJoinExpression](#addJoinExpression(org.apache.groovy.ginq.dsl.expression.JoinExpression))([JoinExpression](joinexpression) joinExpression)` \| \| \| `public [FromExpression](fromexpression)` \| `[getFromExpression](#getFromExpression())()` \| \| \| `public [GroupExpression](groupexpression)` \| `[getGroupExpression](#getGroupExpression())()` \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[JoinExpression](joinexpression "JoinExpression")>` \| `[getJoinExpressionList](#getJoinExpressionList())()` \| \| \| `public [LimitExpression](limitexpression)` \| `[getLimitExpression](#getLimitExpression())()` \| \| \| `public [OrderExpression](orderexpression)` \| `[getOrderExpression](#getOrderExpression())()` \| \| \| `public [SelectExpression](selectexpression)` \| `[getSelectExpression](#getSelectExpression())()` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getText](#getText())()` \| \| \| `public [WhereExpression](whereexpression)` \| `[getWhereExpression](#getWhereExpression())()` \| \| \| `public void` \| `[setFromExpression](#setFromExpression(org.apache.groovy.ginq.dsl.expression.FromExpression))([FromExpression](fromexpression) fromExpression)` \| \| \| `public void` \| `[setGroupExpression](#setGroupExpression(org.apache.groovy.ginq.dsl.expression.GroupExpression))([GroupExpression](groupexpression) groupExpression)` \| \| \| `public void` \| `[setLimitExpression](#setLimitExpression(org.apache.groovy.ginq.dsl.expression.LimitExpression))([LimitExpression](limitexpression) limitExpression)` \| \| \| `public void` \| `[setOrderExpression](#setOrderExpression(org.apache.groovy.ginq.dsl.expression.OrderExpression))([OrderExpression](orderexpression) orderExpression)` \| \| \| `public void` \| `[setSelectExpression](#setSelectExpression(org.apache.groovy.ginq.dsl.expression.SelectExpression))([SelectExpression](selectexpression) selectExpression)` \| \| \| `public void` \| `[setWhereExpression](#setWhereExpression(org.apache.groovy.ginq.dsl.expression.WhereExpression))([WhereExpression](whereexpression) whereExpression)` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[toString](#toString())()` \| \| \| `public void` \| `[visit](#visit(org.codehaus.groovy.ast.GroovyCodeVisitor))([GroovyCodeVisitor](../../../../../codehaus/groovy/ast/groovycodevisitor) visitor)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractGinqExpression](abstractginqexpression)` \| `[accept](abstractginqexpression#accept(GinqAstVisitor)), [transformExpression](abstractginqexpression#transformExpression(org.codehaus.groovy.ast.expr.ExpressionTransformer)), [visit](abstractginqexpression#visit(org.codehaus.groovy.ast.GroovyCodeVisitor))` \| \| `class [Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[getType](../../../../../codehaus/groovy/ast/expr/expression#getType()), [setType](../../../../../codehaus/groovy/ast/expr/expression#setType(org.codehaus.groovy.ast.ClassNode)), [transformExpression](../../../../../codehaus/groovy/ast/expr/expression#transformExpression(org.codehaus.groovy.ast.expr.ExpressionTransformer)), [transformExpressions](../../../../../codehaus/groovy/ast/expr/expression#transformExpressions(List,%20org.codehaus.groovy.ast.expr.ExpressionTransformer)), [transformExpressions](../../../../../codehaus/groovy/ast/expr/expression#transformExpressions(List,%20org.codehaus.groovy.ast.expr.ExpressionTransformer,%20Class))` \| \| `class [AnnotatedNode](../../../../../codehaus/groovy/ast/annotatednode)` \| `[addAnnotation](../../../../../codehaus/groovy/ast/annotatednode#addAnnotation(org.codehaus.groovy.ast.AnnotationNode)), [addAnnotations](../../../../../codehaus/groovy/ast/annotatednode#addAnnotations(List)), [getAnnotations](../../../../../codehaus/groovy/ast/annotatednode#getAnnotations()), [getAnnotations](../../../../../codehaus/groovy/ast/annotatednode#getAnnotations(org.codehaus.groovy.ast.ClassNode)), [getDeclaringClass](../../../../../codehaus/groovy/ast/annotatednode#getDeclaringClass()), [getGroovydoc](../../../../../codehaus/groovy/ast/annotatednode#getGroovydoc()), [getInstance](../../../../../codehaus/groovy/ast/annotatednode#getInstance()), [hasNoRealSourcePosition](../../../../../codehaus/groovy/ast/annotatednode#hasNoRealSourcePosition()), [isSynthetic](../../../../../codehaus/groovy/ast/annotatednode#isSynthetic()), [setDeclaringClass](../../../../../codehaus/groovy/ast/annotatednode#setDeclaringClass(org.codehaus.groovy.ast.ClassNode)), [setHasNoRealSourcePosition](../../../../../codehaus/groovy/ast/annotatednode#setHasNoRealSourcePosition(boolean)), [setSynthetic](../../../../../codehaus/groovy/ast/annotatednode#setSynthetic(boolean))` \| \| `class [ASTNode](../../../../../codehaus/groovy/ast/astnode)` \| `[copyNodeMetaData](../../../../../codehaus/groovy/ast/astnode#copyNodeMetaData(org.codehaus.groovy.ast.ASTNode)), [getColumnNumber](../../../../../codehaus/groovy/ast/astnode#getColumnNumber()), [getLastColumnNumber](../../../../../codehaus/groovy/ast/astnode#getLastColumnNumber()), [getLastLineNumber](../../../../../codehaus/groovy/ast/astnode#getLastLineNumber()), [getLineNumber](../../../../../codehaus/groovy/ast/astnode#getLineNumber()), [getMetaDataMap](../../../../../codehaus/groovy/ast/astnode#getMetaDataMap()), [getText](../../../../../codehaus/groovy/ast/astnode#getText()), [setColumnNumber](../../../../../codehaus/groovy/ast/astnode#setColumnNumber(int)), [setLastColumnNumber](../../../../../codehaus/groovy/ast/astnode#setLastColumnNumber(int)), [setLastLineNumber](../../../../../codehaus/groovy/ast/astnode#setLastLineNumber(int)), [setLineNumber](../../../../../codehaus/groovy/ast/astnode#setLineNumber(int)), [setMetaDataMap](../../../../../codehaus/groovy/ast/astnode#setMetaDataMap(Map)), [setSourcePosition](../../../../../codehaus/groovy/ast/astnode#setSourcePosition(org.codehaus.groovy.ast.ASTNode)), [visit](../../../../../codehaus/groovy/ast/astnode#visit(org.codehaus.groovy.ast.GroovyCodeVisitor))` \| Method Detail ------------- ### <R> @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public R accept([GinqAstVisitor](../ginqastvisitor "GinqAstVisitor")<R> visitor) ### public void addJoinExpression([JoinExpression](joinexpression) joinExpression) ### public [FromExpression](fromexpression) getFromExpression() ### public [GroupExpression](groupexpression) getGroupExpression() ### public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[JoinExpression](joinexpression "JoinExpression")> getJoinExpressionList() ### public [LimitExpression](limitexpression) getLimitExpression() ### public [OrderExpression](orderexpression) getOrderExpression() ### public [SelectExpression](selectexpression) getSelectExpression() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getText() ### public [WhereExpression](whereexpression) getWhereExpression() ### public void setFromExpression([FromExpression](fromexpression) fromExpression) ### public void setGroupExpression([GroupExpression](groupexpression) groupExpression) ### public void setLimitExpression([LimitExpression](limitexpression) limitExpression) ### public void setOrderExpression([OrderExpression](orderexpression) orderExpression) ### public void setSelectExpression([SelectExpression](selectexpression) selectExpression) ### public void setWhereExpression([WhereExpression](whereexpression) whereExpression) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") toString() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void visit([GroovyCodeVisitor](../../../../../codehaus/groovy/ast/groovycodevisitor) visitor) groovy [Java] Class ShutdownExpression [Java] Class ShutdownExpression =============================== * org.apache.groovy.ginq.dsl.expression.ShutdownExpression ``` public class ShutdownExpression extends [AbstractGinqExpression](abstractginqexpression) ``` Represent the shutdown expression Since: 4.0.0 Inherited fields \| Fields inherited from class \| Fields \| \| `class [Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[EMPTY\_ARRAY](../../../../../codehaus/groovy/ast/expr/expression#EMPTY_ARRAY)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[ShutdownExpression](#ShutdownExpression(org.codehaus.groovy.ast.expr.Expression,%20int))([Expression](../../../../../codehaus/groovy/ast/expr/expression) expr, int mode)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| `<R>` \| `public R` \| `[accept](#accept(GinqAstVisitor))([GinqAstVisitor](../ginqastvisitor "GinqAstVisitor")<R> visitor)` \| \| \| `public [Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[getExpr](#getExpr())()` \| \| \| `public int` \| `[getMode](#getMode())()` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getText](#getText())()` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[toString](#toString())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractGinqExpression](abstractginqexpression)` \| `[accept](abstractginqexpression#accept(GinqAstVisitor)), [transformExpression](abstractginqexpression#transformExpression(org.codehaus.groovy.ast.expr.ExpressionTransformer)), [visit](abstractginqexpression#visit(org.codehaus.groovy.ast.GroovyCodeVisitor))` \| \| `class [Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[getType](../../../../../codehaus/groovy/ast/expr/expression#getType()), [setType](../../../../../codehaus/groovy/ast/expr/expression#setType(org.codehaus.groovy.ast.ClassNode)), [transformExpression](../../../../../codehaus/groovy/ast/expr/expression#transformExpression(org.codehaus.groovy.ast.expr.ExpressionTransformer)), [transformExpressions](../../../../../codehaus/groovy/ast/expr/expression#transformExpressions(List,%20org.codehaus.groovy.ast.expr.ExpressionTransformer)), [transformExpressions](../../../../../codehaus/groovy/ast/expr/expression#transformExpressions(List,%20org.codehaus.groovy.ast.expr.ExpressionTransformer,%20Class))` \| \| `class [AnnotatedNode](../../../../../codehaus/groovy/ast/annotatednode)` \| `[addAnnotation](../../../../../codehaus/groovy/ast/annotatednode#addAnnotation(org.codehaus.groovy.ast.AnnotationNode)), [addAnnotations](../../../../../codehaus/groovy/ast/annotatednode#addAnnotations(List)), [getAnnotations](../../../../../codehaus/groovy/ast/annotatednode#getAnnotations()), [getAnnotations](../../../../../codehaus/groovy/ast/annotatednode#getAnnotations(org.codehaus.groovy.ast.ClassNode)), [getDeclaringClass](../../../../../codehaus/groovy/ast/annotatednode#getDeclaringClass()), [getGroovydoc](../../../../../codehaus/groovy/ast/annotatednode#getGroovydoc()), [getInstance](../../../../../codehaus/groovy/ast/annotatednode#getInstance()), [hasNoRealSourcePosition](../../../../../codehaus/groovy/ast/annotatednode#hasNoRealSourcePosition()), [isSynthetic](../../../../../codehaus/groovy/ast/annotatednode#isSynthetic()), [setDeclaringClass](../../../../../codehaus/groovy/ast/annotatednode#setDeclaringClass(org.codehaus.groovy.ast.ClassNode)), [setHasNoRealSourcePosition](../../../../../codehaus/groovy/ast/annotatednode#setHasNoRealSourcePosition(boolean)), [setSynthetic](../../../../../codehaus/groovy/ast/annotatednode#setSynthetic(boolean))` \| \| `class [ASTNode](../../../../../codehaus/groovy/ast/astnode)` \| `[copyNodeMetaData](../../../../../codehaus/groovy/ast/astnode#copyNodeMetaData(org.codehaus.groovy.ast.ASTNode)), [getColumnNumber](../../../../../codehaus/groovy/ast/astnode#getColumnNumber()), [getLastColumnNumber](../../../../../codehaus/groovy/ast/astnode#getLastColumnNumber()), [getLastLineNumber](../../../../../codehaus/groovy/ast/astnode#getLastLineNumber()), [getLineNumber](../../../../../codehaus/groovy/ast/astnode#getLineNumber()), [getMetaDataMap](../../../../../codehaus/groovy/ast/astnode#getMetaDataMap()), [getText](../../../../../codehaus/groovy/ast/astnode#getText()), [setColumnNumber](../../../../../codehaus/groovy/ast/astnode#setColumnNumber(int)), [setLastColumnNumber](../../../../../codehaus/groovy/ast/astnode#setLastColumnNumber(int)), [setLastLineNumber](../../../../../codehaus/groovy/ast/astnode#setLastLineNumber(int)), [setLineNumber](../../../../../codehaus/groovy/ast/astnode#setLineNumber(int)), [setMetaDataMap](../../../../../codehaus/groovy/ast/astnode#setMetaDataMap(Map)), [setSourcePosition](../../../../../codehaus/groovy/ast/astnode#setSourcePosition(org.codehaus.groovy.ast.ASTNode)), [visit](../../../../../codehaus/groovy/ast/astnode#visit(org.codehaus.groovy.ast.GroovyCodeVisitor))` \| Constructor Detail ------------------ ### public ShutdownExpression([Expression](../../../../../codehaus/groovy/ast/expr/expression) expr, int mode) Method Detail ------------- ### <R> @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public R accept([GinqAstVisitor](../ginqastvisitor "GinqAstVisitor")<R> visitor) ### public [Expression](../../../../../codehaus/groovy/ast/expr/expression) getExpr() ### public int getMode() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getText() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") toString()	programming_docs
groovy [Java] Class ProcessExpression [Java] Class ProcessExpression ============================== * org.apache.groovy.ginq.dsl.expression.ProcessExpression All Implemented Interfaces and Traits: [DataSourceHolder](datasourceholder) ``` public abstract class ProcessExpression extends [AbstractGinqExpression](abstractginqexpression) implements [DataSourceHolder](datasourceholder) ``` Represents process expression, e.g. where, groupby, orderby, limit, select Since: 4.0.0 Inherited fields \| Fields inherited from class \| Fields \| \| `class [Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[EMPTY\_ARRAY](../../../../../codehaus/groovy/ast/expr/expression#EMPTY_ARRAY)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [DataSourceExpression](datasourceexpression)` \| `[getDataSourceExpression](#getDataSourceExpression())()` \| \| \| `public void` \| `[setDataSourceExpression](#setDataSourceExpression(org.apache.groovy.ginq.dsl.expression.DataSourceExpression))([DataSourceExpression](datasourceexpression) dataSourceExpression)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractGinqExpression](abstractginqexpression)` \| `[accept](abstractginqexpression#accept(GinqAstVisitor)), [transformExpression](abstractginqexpression#transformExpression(org.codehaus.groovy.ast.expr.ExpressionTransformer)), [visit](abstractginqexpression#visit(org.codehaus.groovy.ast.GroovyCodeVisitor))` \| \| `class [Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[getType](../../../../../codehaus/groovy/ast/expr/expression#getType()), [setType](../../../../../codehaus/groovy/ast/expr/expression#setType(org.codehaus.groovy.ast.ClassNode)), [transformExpression](../../../../../codehaus/groovy/ast/expr/expression#transformExpression(org.codehaus.groovy.ast.expr.ExpressionTransformer)), [transformExpressions](../../../../../codehaus/groovy/ast/expr/expression#transformExpressions(List,%20org.codehaus.groovy.ast.expr.ExpressionTransformer)), [transformExpressions](../../../../../codehaus/groovy/ast/expr/expression#transformExpressions(List,%20org.codehaus.groovy.ast.expr.ExpressionTransformer,%20Class))` \| \| `class [AnnotatedNode](../../../../../codehaus/groovy/ast/annotatednode)` \| `[addAnnotation](../../../../../codehaus/groovy/ast/annotatednode#addAnnotation(org.codehaus.groovy.ast.AnnotationNode)), [addAnnotations](../../../../../codehaus/groovy/ast/annotatednode#addAnnotations(List)), [getAnnotations](../../../../../codehaus/groovy/ast/annotatednode#getAnnotations()), [getAnnotations](../../../../../codehaus/groovy/ast/annotatednode#getAnnotations(org.codehaus.groovy.ast.ClassNode)), [getDeclaringClass](../../../../../codehaus/groovy/ast/annotatednode#getDeclaringClass()), [getGroovydoc](../../../../../codehaus/groovy/ast/annotatednode#getGroovydoc()), [getInstance](../../../../../codehaus/groovy/ast/annotatednode#getInstance()), [hasNoRealSourcePosition](../../../../../codehaus/groovy/ast/annotatednode#hasNoRealSourcePosition()), [isSynthetic](../../../../../codehaus/groovy/ast/annotatednode#isSynthetic()), [setDeclaringClass](../../../../../codehaus/groovy/ast/annotatednode#setDeclaringClass(org.codehaus.groovy.ast.ClassNode)), [setHasNoRealSourcePosition](../../../../../codehaus/groovy/ast/annotatednode#setHasNoRealSourcePosition(boolean)), [setSynthetic](../../../../../codehaus/groovy/ast/annotatednode#setSynthetic(boolean))` \| \| `class [ASTNode](../../../../../codehaus/groovy/ast/astnode)` \| `[copyNodeMetaData](../../../../../codehaus/groovy/ast/astnode#copyNodeMetaData(org.codehaus.groovy.ast.ASTNode)), [getColumnNumber](../../../../../codehaus/groovy/ast/astnode#getColumnNumber()), [getLastColumnNumber](../../../../../codehaus/groovy/ast/astnode#getLastColumnNumber()), [getLastLineNumber](../../../../../codehaus/groovy/ast/astnode#getLastLineNumber()), [getLineNumber](../../../../../codehaus/groovy/ast/astnode#getLineNumber()), [getMetaDataMap](../../../../../codehaus/groovy/ast/astnode#getMetaDataMap()), [getText](../../../../../codehaus/groovy/ast/astnode#getText()), [setColumnNumber](../../../../../codehaus/groovy/ast/astnode#setColumnNumber(int)), [setLastColumnNumber](../../../../../codehaus/groovy/ast/astnode#setLastColumnNumber(int)), [setLastLineNumber](../../../../../codehaus/groovy/ast/astnode#setLastLineNumber(int)), [setLineNumber](../../../../../codehaus/groovy/ast/astnode#setLineNumber(int)), [setMetaDataMap](../../../../../codehaus/groovy/ast/astnode#setMetaDataMap(Map)), [setSourcePosition](../../../../../codehaus/groovy/ast/astnode#setSourcePosition(org.codehaus.groovy.ast.ASTNode)), [visit](../../../../../codehaus/groovy/ast/astnode#visit(org.codehaus.groovy.ast.GroovyCodeVisitor))` \| Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [DataSourceExpression](datasourceexpression) getDataSourceExpression() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void setDataSourceExpression([DataSourceExpression](datasourceexpression) dataSourceExpression) groovy [Java] Class OnExpression [Java] Class OnExpression ========================= * org.apache.groovy.ginq.dsl.expression.OnExpression ``` public class OnExpression extends [FilterExpression](filterexpression) ``` Represents on expression Since: 4.0.0 Inherited fields \| Fields inherited from class \| Fields \| \| `class [FilterExpression](filterexpression)` \| `[filterExpr](filterexpression#filterExpr)` \| \| `class [Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[EMPTY\_ARRAY](../../../../../codehaus/groovy/ast/expr/expression#EMPTY_ARRAY)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[OnExpression](#OnExpression(org.codehaus.groovy.ast.expr.Expression))([Expression](../../../../../codehaus/groovy/ast/expr/expression) filterExpr)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| `<R>` \| `public R` \| `[accept](#accept(GinqAstVisitor))([GinqAstVisitor](../ginqastvisitor "GinqAstVisitor")<R> visitor)` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getText](#getText())()` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[toString](#toString())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [FilterExpression](filterexpression)` \| `[getFilterExpr](filterexpression#getFilterExpr()), [setFilterExpr](filterexpression#setFilterExpr(org.codehaus.groovy.ast.expr.Expression))` \| \| `class [ProcessExpression](processexpression)` \| `[getDataSourceExpression](processexpression#getDataSourceExpression()), [setDataSourceExpression](processexpression#setDataSourceExpression(org.apache.groovy.ginq.dsl.expression.DataSourceExpression))` \| \| `class [AbstractGinqExpression](abstractginqexpression)` \| `[accept](abstractginqexpression#accept(GinqAstVisitor)), [transformExpression](abstractginqexpression#transformExpression(org.codehaus.groovy.ast.expr.ExpressionTransformer)), [visit](abstractginqexpression#visit(org.codehaus.groovy.ast.GroovyCodeVisitor))` \| \| `class [Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[getType](../../../../../codehaus/groovy/ast/expr/expression#getType()), [setType](../../../../../codehaus/groovy/ast/expr/expression#setType(org.codehaus.groovy.ast.ClassNode)), [transformExpression](../../../../../codehaus/groovy/ast/expr/expression#transformExpression(org.codehaus.groovy.ast.expr.ExpressionTransformer)), [transformExpressions](../../../../../codehaus/groovy/ast/expr/expression#transformExpressions(List,%20org.codehaus.groovy.ast.expr.ExpressionTransformer)), [transformExpressions](../../../../../codehaus/groovy/ast/expr/expression#transformExpressions(List,%20org.codehaus.groovy.ast.expr.ExpressionTransformer,%20Class))` \| \| `class [AnnotatedNode](../../../../../codehaus/groovy/ast/annotatednode)` \| `[addAnnotation](../../../../../codehaus/groovy/ast/annotatednode#addAnnotation(org.codehaus.groovy.ast.AnnotationNode)), [addAnnotations](../../../../../codehaus/groovy/ast/annotatednode#addAnnotations(List)), [getAnnotations](../../../../../codehaus/groovy/ast/annotatednode#getAnnotations()), [getAnnotations](../../../../../codehaus/groovy/ast/annotatednode#getAnnotations(org.codehaus.groovy.ast.ClassNode)), [getDeclaringClass](../../../../../codehaus/groovy/ast/annotatednode#getDeclaringClass()), [getGroovydoc](../../../../../codehaus/groovy/ast/annotatednode#getGroovydoc()), [getInstance](../../../../../codehaus/groovy/ast/annotatednode#getInstance()), [hasNoRealSourcePosition](../../../../../codehaus/groovy/ast/annotatednode#hasNoRealSourcePosition()), [isSynthetic](../../../../../codehaus/groovy/ast/annotatednode#isSynthetic()), [setDeclaringClass](../../../../../codehaus/groovy/ast/annotatednode#setDeclaringClass(org.codehaus.groovy.ast.ClassNode)), [setHasNoRealSourcePosition](../../../../../codehaus/groovy/ast/annotatednode#setHasNoRealSourcePosition(boolean)), [setSynthetic](../../../../../codehaus/groovy/ast/annotatednode#setSynthetic(boolean))` \| \| `class [ASTNode](../../../../../codehaus/groovy/ast/astnode)` \| `[copyNodeMetaData](../../../../../codehaus/groovy/ast/astnode#copyNodeMetaData(org.codehaus.groovy.ast.ASTNode)), [getColumnNumber](../../../../../codehaus/groovy/ast/astnode#getColumnNumber()), [getLastColumnNumber](../../../../../codehaus/groovy/ast/astnode#getLastColumnNumber()), [getLastLineNumber](../../../../../codehaus/groovy/ast/astnode#getLastLineNumber()), [getLineNumber](../../../../../codehaus/groovy/ast/astnode#getLineNumber()), [getMetaDataMap](../../../../../codehaus/groovy/ast/astnode#getMetaDataMap()), [getText](../../../../../codehaus/groovy/ast/astnode#getText()), [setColumnNumber](../../../../../codehaus/groovy/ast/astnode#setColumnNumber(int)), [setLastColumnNumber](../../../../../codehaus/groovy/ast/astnode#setLastColumnNumber(int)), [setLastLineNumber](../../../../../codehaus/groovy/ast/astnode#setLastLineNumber(int)), [setLineNumber](../../../../../codehaus/groovy/ast/astnode#setLineNumber(int)), [setMetaDataMap](../../../../../codehaus/groovy/ast/astnode#setMetaDataMap(Map)), [setSourcePosition](../../../../../codehaus/groovy/ast/astnode#setSourcePosition(org.codehaus.groovy.ast.ASTNode)), [visit](../../../../../codehaus/groovy/ast/astnode#visit(org.codehaus.groovy.ast.GroovyCodeVisitor))` \| Constructor Detail ------------------ ### public OnExpression([Expression](../../../../../codehaus/groovy/ast/expr/expression) filterExpr) Method Detail ------------- ### <R> @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public R accept([GinqAstVisitor](../ginqastvisitor "GinqAstVisitor")<R> visitor) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getText() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") toString() groovy [Java] Class SelectExpression [Java] Class SelectExpression ============================= * org.apache.groovy.ginq.dsl.expression.SelectExpression ``` public class SelectExpression extends [ProcessExpression](processexpression) ``` Represents the select expression Since: 4.0.0 Inherited fields \| Fields inherited from class \| Fields \| \| `class [Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[EMPTY\_ARRAY](../../../../../codehaus/groovy/ast/expr/expression#EMPTY_ARRAY)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[SelectExpression](#SelectExpression(org.codehaus.groovy.ast.expr.Expression))([Expression](../../../../../codehaus/groovy/ast/expr/expression) projectionExpr)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| `<R>` \| `public R` \| `[accept](#accept(GinqAstVisitor))([GinqAstVisitor](../ginqastvisitor "GinqAstVisitor")<R> visitor)` \| \| \| `public [Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[getProjectionExpr](#getProjectionExpr())()` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getText](#getText())()` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[toString](#toString())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [ProcessExpression](processexpression)` \| `[getDataSourceExpression](processexpression#getDataSourceExpression()), [setDataSourceExpression](processexpression#setDataSourceExpression(org.apache.groovy.ginq.dsl.expression.DataSourceExpression))` \| \| `class [AbstractGinqExpression](abstractginqexpression)` \| `[accept](abstractginqexpression#accept(GinqAstVisitor)), [transformExpression](abstractginqexpression#transformExpression(org.codehaus.groovy.ast.expr.ExpressionTransformer)), [visit](abstractginqexpression#visit(org.codehaus.groovy.ast.GroovyCodeVisitor))` \| \| `class [Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[getType](../../../../../codehaus/groovy/ast/expr/expression#getType()), [setType](../../../../../codehaus/groovy/ast/expr/expression#setType(org.codehaus.groovy.ast.ClassNode)), [transformExpression](../../../../../codehaus/groovy/ast/expr/expression#transformExpression(org.codehaus.groovy.ast.expr.ExpressionTransformer)), [transformExpressions](../../../../../codehaus/groovy/ast/expr/expression#transformExpressions(List,%20org.codehaus.groovy.ast.expr.ExpressionTransformer)), [transformExpressions](../../../../../codehaus/groovy/ast/expr/expression#transformExpressions(List,%20org.codehaus.groovy.ast.expr.ExpressionTransformer,%20Class))` \| \| `class [AnnotatedNode](../../../../../codehaus/groovy/ast/annotatednode)` \| `[addAnnotation](../../../../../codehaus/groovy/ast/annotatednode#addAnnotation(org.codehaus.groovy.ast.AnnotationNode)), [addAnnotations](../../../../../codehaus/groovy/ast/annotatednode#addAnnotations(List)), [getAnnotations](../../../../../codehaus/groovy/ast/annotatednode#getAnnotations()), [getAnnotations](../../../../../codehaus/groovy/ast/annotatednode#getAnnotations(org.codehaus.groovy.ast.ClassNode)), [getDeclaringClass](../../../../../codehaus/groovy/ast/annotatednode#getDeclaringClass()), [getGroovydoc](../../../../../codehaus/groovy/ast/annotatednode#getGroovydoc()), [getInstance](../../../../../codehaus/groovy/ast/annotatednode#getInstance()), [hasNoRealSourcePosition](../../../../../codehaus/groovy/ast/annotatednode#hasNoRealSourcePosition()), [isSynthetic](../../../../../codehaus/groovy/ast/annotatednode#isSynthetic()), [setDeclaringClass](../../../../../codehaus/groovy/ast/annotatednode#setDeclaringClass(org.codehaus.groovy.ast.ClassNode)), [setHasNoRealSourcePosition](../../../../../codehaus/groovy/ast/annotatednode#setHasNoRealSourcePosition(boolean)), [setSynthetic](../../../../../codehaus/groovy/ast/annotatednode#setSynthetic(boolean))` \| \| `class [ASTNode](../../../../../codehaus/groovy/ast/astnode)` \| `[copyNodeMetaData](../../../../../codehaus/groovy/ast/astnode#copyNodeMetaData(org.codehaus.groovy.ast.ASTNode)), [getColumnNumber](../../../../../codehaus/groovy/ast/astnode#getColumnNumber()), [getLastColumnNumber](../../../../../codehaus/groovy/ast/astnode#getLastColumnNumber()), [getLastLineNumber](../../../../../codehaus/groovy/ast/astnode#getLastLineNumber()), [getLineNumber](../../../../../codehaus/groovy/ast/astnode#getLineNumber()), [getMetaDataMap](../../../../../codehaus/groovy/ast/astnode#getMetaDataMap()), [getText](../../../../../codehaus/groovy/ast/astnode#getText()), [setColumnNumber](../../../../../codehaus/groovy/ast/astnode#setColumnNumber(int)), [setLastColumnNumber](../../../../../codehaus/groovy/ast/astnode#setLastColumnNumber(int)), [setLastLineNumber](../../../../../codehaus/groovy/ast/astnode#setLastLineNumber(int)), [setLineNumber](../../../../../codehaus/groovy/ast/astnode#setLineNumber(int)), [setMetaDataMap](../../../../../codehaus/groovy/ast/astnode#setMetaDataMap(Map)), [setSourcePosition](../../../../../codehaus/groovy/ast/astnode#setSourcePosition(org.codehaus.groovy.ast.ASTNode)), [visit](../../../../../codehaus/groovy/ast/astnode#visit(org.codehaus.groovy.ast.GroovyCodeVisitor))` \| Constructor Detail ------------------ ### public SelectExpression([Expression](../../../../../codehaus/groovy/ast/expr/expression) projectionExpr) Method Detail ------------- ### <R> @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public R accept([GinqAstVisitor](../ginqastvisitor "GinqAstVisitor")<R> visitor) ### public [Expression](../../../../../codehaus/groovy/ast/expr/expression) getProjectionExpr() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getText() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") toString() groovy [Java] Class HavingExpression [Java] Class HavingExpression ============================= * org.apache.groovy.ginq.dsl.expression.HavingExpression ``` public class HavingExpression extends [FilterExpression](filterexpression) ``` Represents having expression Since: 4.0.0 Inherited fields \| Fields inherited from class \| Fields \| \| `class [FilterExpression](filterexpression)` \| `[filterExpr](filterexpression#filterExpr)` \| \| `class [Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[EMPTY\_ARRAY](../../../../../codehaus/groovy/ast/expr/expression#EMPTY_ARRAY)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[HavingExpression](#HavingExpression(org.codehaus.groovy.ast.expr.Expression))([Expression](../../../../../codehaus/groovy/ast/expr/expression) filterExpr)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| `<R>` \| `public R` \| `[accept](#accept(GinqAstVisitor))([GinqAstVisitor](../ginqastvisitor "GinqAstVisitor")<R> visitor)` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getText](#getText())()` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[toString](#toString())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [FilterExpression](filterexpression)` \| `[getFilterExpr](filterexpression#getFilterExpr()), [setFilterExpr](filterexpression#setFilterExpr(org.codehaus.groovy.ast.expr.Expression))` \| \| `class [ProcessExpression](processexpression)` \| `[getDataSourceExpression](processexpression#getDataSourceExpression()), [setDataSourceExpression](processexpression#setDataSourceExpression(org.apache.groovy.ginq.dsl.expression.DataSourceExpression))` \| \| `class [AbstractGinqExpression](abstractginqexpression)` \| `[accept](abstractginqexpression#accept(GinqAstVisitor)), [transformExpression](abstractginqexpression#transformExpression(org.codehaus.groovy.ast.expr.ExpressionTransformer)), [visit](abstractginqexpression#visit(org.codehaus.groovy.ast.GroovyCodeVisitor))` \| \| `class [Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[getType](../../../../../codehaus/groovy/ast/expr/expression#getType()), [setType](../../../../../codehaus/groovy/ast/expr/expression#setType(org.codehaus.groovy.ast.ClassNode)), [transformExpression](../../../../../codehaus/groovy/ast/expr/expression#transformExpression(org.codehaus.groovy.ast.expr.ExpressionTransformer)), [transformExpressions](../../../../../codehaus/groovy/ast/expr/expression#transformExpressions(List,%20org.codehaus.groovy.ast.expr.ExpressionTransformer)), [transformExpressions](../../../../../codehaus/groovy/ast/expr/expression#transformExpressions(List,%20org.codehaus.groovy.ast.expr.ExpressionTransformer,%20Class))` \| \| `class [AnnotatedNode](../../../../../codehaus/groovy/ast/annotatednode)` \| `[addAnnotation](../../../../../codehaus/groovy/ast/annotatednode#addAnnotation(org.codehaus.groovy.ast.AnnotationNode)), [addAnnotations](../../../../../codehaus/groovy/ast/annotatednode#addAnnotations(List)), [getAnnotations](../../../../../codehaus/groovy/ast/annotatednode#getAnnotations()), [getAnnotations](../../../../../codehaus/groovy/ast/annotatednode#getAnnotations(org.codehaus.groovy.ast.ClassNode)), [getDeclaringClass](../../../../../codehaus/groovy/ast/annotatednode#getDeclaringClass()), [getGroovydoc](../../../../../codehaus/groovy/ast/annotatednode#getGroovydoc()), [getInstance](../../../../../codehaus/groovy/ast/annotatednode#getInstance()), [hasNoRealSourcePosition](../../../../../codehaus/groovy/ast/annotatednode#hasNoRealSourcePosition()), [isSynthetic](../../../../../codehaus/groovy/ast/annotatednode#isSynthetic()), [setDeclaringClass](../../../../../codehaus/groovy/ast/annotatednode#setDeclaringClass(org.codehaus.groovy.ast.ClassNode)), [setHasNoRealSourcePosition](../../../../../codehaus/groovy/ast/annotatednode#setHasNoRealSourcePosition(boolean)), [setSynthetic](../../../../../codehaus/groovy/ast/annotatednode#setSynthetic(boolean))` \| \| `class [ASTNode](../../../../../codehaus/groovy/ast/astnode)` \| `[copyNodeMetaData](../../../../../codehaus/groovy/ast/astnode#copyNodeMetaData(org.codehaus.groovy.ast.ASTNode)), [getColumnNumber](../../../../../codehaus/groovy/ast/astnode#getColumnNumber()), [getLastColumnNumber](../../../../../codehaus/groovy/ast/astnode#getLastColumnNumber()), [getLastLineNumber](../../../../../codehaus/groovy/ast/astnode#getLastLineNumber()), [getLineNumber](../../../../../codehaus/groovy/ast/astnode#getLineNumber()), [getMetaDataMap](../../../../../codehaus/groovy/ast/astnode#getMetaDataMap()), [getText](../../../../../codehaus/groovy/ast/astnode#getText()), [setColumnNumber](../../../../../codehaus/groovy/ast/astnode#setColumnNumber(int)), [setLastColumnNumber](../../../../../codehaus/groovy/ast/astnode#setLastColumnNumber(int)), [setLastLineNumber](../../../../../codehaus/groovy/ast/astnode#setLastLineNumber(int)), [setLineNumber](../../../../../codehaus/groovy/ast/astnode#setLineNumber(int)), [setMetaDataMap](../../../../../codehaus/groovy/ast/astnode#setMetaDataMap(Map)), [setSourcePosition](../../../../../codehaus/groovy/ast/astnode#setSourcePosition(org.codehaus.groovy.ast.ASTNode)), [visit](../../../../../codehaus/groovy/ast/astnode#visit(org.codehaus.groovy.ast.GroovyCodeVisitor))` \| Constructor Detail ------------------ ### public HavingExpression([Expression](../../../../../codehaus/groovy/ast/expr/expression) filterExpr) Method Detail ------------- ### <R> @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public R accept([GinqAstVisitor](../ginqastvisitor "GinqAstVisitor")<R> visitor) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getText() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") toString()	programming_docs
groovy [Java] Class DataSourceExpression [Java] Class DataSourceExpression ================================= * org.apache.groovy.ginq.dsl.expression.DataSourceExpression All Implemented Interfaces and Traits: [DataSourceHolder](datasourceholder) ``` public abstract class DataSourceExpression extends [AbstractGinqExpression](abstractginqexpression) implements [DataSourceHolder](datasourceholder) ``` Represents data source expression Since: 4.0.0 Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `protected [Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[aliasExpr](#aliasExpr)` \| \| \| `protected [Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[dataSourceExpr](#dataSourceExpr)` \| \| Inherited fields \| Fields inherited from class \| Fields \| \| `class [Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[EMPTY\_ARRAY](../../../../../codehaus/groovy/ast/expr/expression#EMPTY_ARRAY)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[DataSourceExpression](#DataSourceExpression(org.codehaus.groovy.ast.expr.Expression,%20org.codehaus.groovy.ast.expr.Expression))([Expression](../../../../../codehaus/groovy/ast/expr/expression) aliasExpr, [Expression](../../../../../codehaus/groovy/ast/expr/expression) dataSourceExpr)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[getAliasExpr](#getAliasExpr())()` \| \| \| `public [Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[getDataSourceExpr](#getDataSourceExpr())()` \| \| \| `public void` \| `[setDataSourceExpr](#setDataSourceExpr(org.codehaus.groovy.ast.expr.Expression))([Expression](../../../../../codehaus/groovy/ast/expr/expression) dataSourceExpr)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractGinqExpression](abstractginqexpression)` \| `[accept](abstractginqexpression#accept(GinqAstVisitor)), [transformExpression](abstractginqexpression#transformExpression(org.codehaus.groovy.ast.expr.ExpressionTransformer)), [visit](abstractginqexpression#visit(org.codehaus.groovy.ast.GroovyCodeVisitor))` \| \| `class [Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[getType](../../../../../codehaus/groovy/ast/expr/expression#getType()), [setType](../../../../../codehaus/groovy/ast/expr/expression#setType(org.codehaus.groovy.ast.ClassNode)), [transformExpression](../../../../../codehaus/groovy/ast/expr/expression#transformExpression(org.codehaus.groovy.ast.expr.ExpressionTransformer)), [transformExpressions](../../../../../codehaus/groovy/ast/expr/expression#transformExpressions(List,%20org.codehaus.groovy.ast.expr.ExpressionTransformer)), [transformExpressions](../../../../../codehaus/groovy/ast/expr/expression#transformExpressions(List,%20org.codehaus.groovy.ast.expr.ExpressionTransformer,%20Class))` \| \| `class [AnnotatedNode](../../../../../codehaus/groovy/ast/annotatednode)` \| `[addAnnotation](../../../../../codehaus/groovy/ast/annotatednode#addAnnotation(org.codehaus.groovy.ast.AnnotationNode)), [addAnnotations](../../../../../codehaus/groovy/ast/annotatednode#addAnnotations(List)), [getAnnotations](../../../../../codehaus/groovy/ast/annotatednode#getAnnotations()), [getAnnotations](../../../../../codehaus/groovy/ast/annotatednode#getAnnotations(org.codehaus.groovy.ast.ClassNode)), [getDeclaringClass](../../../../../codehaus/groovy/ast/annotatednode#getDeclaringClass()), [getGroovydoc](../../../../../codehaus/groovy/ast/annotatednode#getGroovydoc()), [getInstance](../../../../../codehaus/groovy/ast/annotatednode#getInstance()), [hasNoRealSourcePosition](../../../../../codehaus/groovy/ast/annotatednode#hasNoRealSourcePosition()), [isSynthetic](../../../../../codehaus/groovy/ast/annotatednode#isSynthetic()), [setDeclaringClass](../../../../../codehaus/groovy/ast/annotatednode#setDeclaringClass(org.codehaus.groovy.ast.ClassNode)), [setHasNoRealSourcePosition](../../../../../codehaus/groovy/ast/annotatednode#setHasNoRealSourcePosition(boolean)), [setSynthetic](../../../../../codehaus/groovy/ast/annotatednode#setSynthetic(boolean))` \| \| `class [ASTNode](../../../../../codehaus/groovy/ast/astnode)` \| `[copyNodeMetaData](../../../../../codehaus/groovy/ast/astnode#copyNodeMetaData(org.codehaus.groovy.ast.ASTNode)), [getColumnNumber](../../../../../codehaus/groovy/ast/astnode#getColumnNumber()), [getLastColumnNumber](../../../../../codehaus/groovy/ast/astnode#getLastColumnNumber()), [getLastLineNumber](../../../../../codehaus/groovy/ast/astnode#getLastLineNumber()), [getLineNumber](../../../../../codehaus/groovy/ast/astnode#getLineNumber()), [getMetaDataMap](../../../../../codehaus/groovy/ast/astnode#getMetaDataMap()), [getText](../../../../../codehaus/groovy/ast/astnode#getText()), [setColumnNumber](../../../../../codehaus/groovy/ast/astnode#setColumnNumber(int)), [setLastColumnNumber](../../../../../codehaus/groovy/ast/astnode#setLastColumnNumber(int)), [setLastLineNumber](../../../../../codehaus/groovy/ast/astnode#setLastLineNumber(int)), [setLineNumber](../../../../../codehaus/groovy/ast/astnode#setLineNumber(int)), [setMetaDataMap](../../../../../codehaus/groovy/ast/astnode#setMetaDataMap(Map)), [setSourcePosition](../../../../../codehaus/groovy/ast/astnode#setSourcePosition(org.codehaus.groovy.ast.ASTNode)), [visit](../../../../../codehaus/groovy/ast/astnode#visit(org.codehaus.groovy.ast.GroovyCodeVisitor))` \| Field Detail ------------ ### protected final [Expression](../../../../../codehaus/groovy/ast/expr/expression) aliasExpr ### protected [Expression](../../../../../codehaus/groovy/ast/expr/expression) dataSourceExpr Constructor Detail ------------------ ### public DataSourceExpression([Expression](../../../../../codehaus/groovy/ast/expr/expression) aliasExpr, [Expression](../../../../../codehaus/groovy/ast/expr/expression) dataSourceExpr) Method Detail ------------- ### public [Expression](../../../../../codehaus/groovy/ast/expr/expression) getAliasExpr() ### public [Expression](../../../../../codehaus/groovy/ast/expr/expression) getDataSourceExpr() ### public void setDataSourceExpr([Expression](../../../../../codehaus/groovy/ast/expr/expression) dataSourceExpr) groovy [Java] Class JoinExpression [Java] Class JoinExpression =========================== * org.apache.groovy.ginq.dsl.expression.JoinExpression All Implemented Interfaces and Traits: [DataSourceHolder](datasourceholder) ``` public class JoinExpression extends [DataSourceExpression](datasourceexpression) implements [DataSourceHolder](datasourceholder) ``` Represents join expression Since: 4.0.0 Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[INNER\_HASH\_JOIN](#INNER_HASH_JOIN)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[INNER\_JOIN](#INNER_JOIN)` \| \| \| `static [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>` \| `[JOIN\_NAME\_LIST](#JOIN_NAME_LIST)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[LEFT\_HASH\_JOIN](#LEFT_HASH_JOIN)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[SMART\_INNER\_JOIN](#SMART_INNER_JOIN)` \| \| Inherited fields \| Fields inherited from class \| Fields \| \| `class [DataSourceExpression](datasourceexpression)` \| `[aliasExpr](datasourceexpression#aliasExpr), [dataSourceExpr](datasourceexpression#dataSourceExpr)` \| \| `class [Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[EMPTY\_ARRAY](../../../../../codehaus/groovy/ast/expr/expression#EMPTY_ARRAY)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[JoinExpression](#JoinExpression(java.lang.String,%20org.codehaus.groovy.ast.expr.Expression,%20org.codehaus.groovy.ast.expr.Expression))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") joinName, [Expression](../../../../../codehaus/groovy/ast/expr/expression) aliasExpr, [Expression](../../../../../codehaus/groovy/ast/expr/expression) dataSourceExpr)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| `<R>` \| `public R` \| `[accept](#accept(GinqAstVisitor))([GinqAstVisitor](../ginqastvisitor "GinqAstVisitor")<R> visitor)` \| \| \| `public [DataSourceExpression](datasourceexpression)` \| `[getDataSourceExpression](#getDataSourceExpression())()` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getJoinName](#getJoinName())()` \| \| \| `public [OnExpression](onexpression)` \| `[getOnExpression](#getOnExpression())()` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getText](#getText())()` \| \| \| `public boolean` \| `[isCrossJoin](#isCrossJoin())()` \| \| \| `public boolean` \| `[isInnerHashJoin](#isInnerHashJoin())()` \| \| \| `public boolean` \| `[isInnerJoin](#isInnerJoin())()` \| \| \| `public static boolean` \| `[isJoinExpression](#isJoinExpression(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName)` \| \| \| `public boolean` \| `[isLeftHashJoin](#isLeftHashJoin())()` \| \| \| `public boolean` \| `[isLeftJoin](#isLeftJoin())()` \| \| \| `public boolean` \| `[isSmartInnerJoin](#isSmartInnerJoin())()` \| \| \| `public void` \| `[setDataSourceExpression](#setDataSourceExpression(org.apache.groovy.ginq.dsl.expression.DataSourceExpression))([DataSourceExpression](datasourceexpression) dataSourceExpression)` \| \| \| `public void` \| `[setOnExpression](#setOnExpression(org.apache.groovy.ginq.dsl.expression.OnExpression))([OnExpression](onexpression) onExpression)` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[toString](#toString())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [DataSourceExpression](datasourceexpression)` \| `[getAliasExpr](datasourceexpression#getAliasExpr()), [getDataSourceExpr](datasourceexpression#getDataSourceExpr()), [setDataSourceExpr](datasourceexpression#setDataSourceExpr(org.codehaus.groovy.ast.expr.Expression))` \| \| `class [AbstractGinqExpression](abstractginqexpression)` \| `[accept](abstractginqexpression#accept(GinqAstVisitor)), [transformExpression](abstractginqexpression#transformExpression(org.codehaus.groovy.ast.expr.ExpressionTransformer)), [visit](abstractginqexpression#visit(org.codehaus.groovy.ast.GroovyCodeVisitor))` \| \| `class [Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[getType](../../../../../codehaus/groovy/ast/expr/expression#getType()), [setType](../../../../../codehaus/groovy/ast/expr/expression#setType(org.codehaus.groovy.ast.ClassNode)), [transformExpression](../../../../../codehaus/groovy/ast/expr/expression#transformExpression(org.codehaus.groovy.ast.expr.ExpressionTransformer)), [transformExpressions](../../../../../codehaus/groovy/ast/expr/expression#transformExpressions(List,%20org.codehaus.groovy.ast.expr.ExpressionTransformer)), [transformExpressions](../../../../../codehaus/groovy/ast/expr/expression#transformExpressions(List,%20org.codehaus.groovy.ast.expr.ExpressionTransformer,%20Class))` \| \| `class [AnnotatedNode](../../../../../codehaus/groovy/ast/annotatednode)` \| `[addAnnotation](../../../../../codehaus/groovy/ast/annotatednode#addAnnotation(org.codehaus.groovy.ast.AnnotationNode)), [addAnnotations](../../../../../codehaus/groovy/ast/annotatednode#addAnnotations(List)), [getAnnotations](../../../../../codehaus/groovy/ast/annotatednode#getAnnotations()), [getAnnotations](../../../../../codehaus/groovy/ast/annotatednode#getAnnotations(org.codehaus.groovy.ast.ClassNode)), [getDeclaringClass](../../../../../codehaus/groovy/ast/annotatednode#getDeclaringClass()), [getGroovydoc](../../../../../codehaus/groovy/ast/annotatednode#getGroovydoc()), [getInstance](../../../../../codehaus/groovy/ast/annotatednode#getInstance()), [hasNoRealSourcePosition](../../../../../codehaus/groovy/ast/annotatednode#hasNoRealSourcePosition()), [isSynthetic](../../../../../codehaus/groovy/ast/annotatednode#isSynthetic()), [setDeclaringClass](../../../../../codehaus/groovy/ast/annotatednode#setDeclaringClass(org.codehaus.groovy.ast.ClassNode)), [setHasNoRealSourcePosition](../../../../../codehaus/groovy/ast/annotatednode#setHasNoRealSourcePosition(boolean)), [setSynthetic](../../../../../codehaus/groovy/ast/annotatednode#setSynthetic(boolean))` \| \| `class [ASTNode](../../../../../codehaus/groovy/ast/astnode)` \| `[copyNodeMetaData](../../../../../codehaus/groovy/ast/astnode#copyNodeMetaData(org.codehaus.groovy.ast.ASTNode)), [getColumnNumber](../../../../../codehaus/groovy/ast/astnode#getColumnNumber()), [getLastColumnNumber](../../../../../codehaus/groovy/ast/astnode#getLastColumnNumber()), [getLastLineNumber](../../../../../codehaus/groovy/ast/astnode#getLastLineNumber()), [getLineNumber](../../../../../codehaus/groovy/ast/astnode#getLineNumber()), [getMetaDataMap](../../../../../codehaus/groovy/ast/astnode#getMetaDataMap()), [getText](../../../../../codehaus/groovy/ast/astnode#getText()), [setColumnNumber](../../../../../codehaus/groovy/ast/astnode#setColumnNumber(int)), [setLastColumnNumber](../../../../../codehaus/groovy/ast/astnode#setLastColumnNumber(int)), [setLastLineNumber](../../../../../codehaus/groovy/ast/astnode#setLastLineNumber(int)), [setLineNumber](../../../../../codehaus/groovy/ast/astnode#setLineNumber(int)), [setMetaDataMap](../../../../../codehaus/groovy/ast/astnode#setMetaDataMap(Map)), [setSourcePosition](../../../../../codehaus/groovy/ast/astnode#setSourcePosition(org.codehaus.groovy.ast.ASTNode)), [visit](../../../../../codehaus/groovy/ast/astnode#visit(org.codehaus.groovy.ast.GroovyCodeVisitor))` \| Field Detail ------------ ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") INNER\_HASH\_JOIN ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") INNER\_JOIN ### public static final [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> JOIN\_NAME\_LIST ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") LEFT\_HASH\_JOIN ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") SMART\_INNER\_JOIN Constructor Detail ------------------ ### public JoinExpression([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") joinName, [Expression](../../../../../codehaus/groovy/ast/expr/expression) aliasExpr, [Expression](../../../../../codehaus/groovy/ast/expr/expression) dataSourceExpr) Method Detail ------------- ### <R> @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public R accept([GinqAstVisitor](../ginqastvisitor "GinqAstVisitor")<R> visitor) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [DataSourceExpression](datasourceexpression) getDataSourceExpression() ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getJoinName() ### public [OnExpression](onexpression) getOnExpression() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getText() ### public boolean isCrossJoin() ### public boolean isInnerHashJoin() ### public boolean isInnerJoin() ### public static boolean isJoinExpression([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName) ### public boolean isLeftHashJoin() ### public boolean isLeftJoin() ### public boolean isSmartInnerJoin() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void setDataSourceExpression([DataSourceExpression](datasourceexpression) dataSourceExpression) ### public void setOnExpression([OnExpression](onexpression) onExpression) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") toString() groovy [Java] Class FromExpression [Java] Class FromExpression =========================== * org.apache.groovy.ginq.dsl.expression.FromExpression ``` public class FromExpression extends [DataSourceExpression](datasourceexpression) ``` Represents the from expression Since: 4.0.0 Inherited fields \| Fields inherited from class \| Fields \| \| `class [DataSourceExpression](datasourceexpression)` \| `[aliasExpr](datasourceexpression#aliasExpr), [dataSourceExpr](datasourceexpression#dataSourceExpr)` \| \| `class [Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[EMPTY\_ARRAY](../../../../../codehaus/groovy/ast/expr/expression#EMPTY_ARRAY)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[FromExpression](#FromExpression(org.codehaus.groovy.ast.expr.Expression,%20org.codehaus.groovy.ast.expr.Expression))([Expression](../../../../../codehaus/groovy/ast/expr/expression) aliasExpr, [Expression](../../../../../codehaus/groovy/ast/expr/expression) dataSourceExpr)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| `<R>` \| `public R` \| `[accept](#accept(GinqAstVisitor))([GinqAstVisitor](../ginqastvisitor "GinqAstVisitor")<R> visitor)` \| \| \| `public [DataSourceExpression](datasourceexpression)` \| `[getDataSourceExpression](#getDataSourceExpression())()` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getText](#getText())()` \| \| \| `public void` \| `[setDataSourceExpression](#setDataSourceExpression(org.apache.groovy.ginq.dsl.expression.DataSourceExpression))([DataSourceExpression](datasourceexpression) dataSourceExpression)` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[toString](#toString())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [DataSourceExpression](datasourceexpression)` \| `[getAliasExpr](datasourceexpression#getAliasExpr()), [getDataSourceExpr](datasourceexpression#getDataSourceExpr()), [setDataSourceExpr](datasourceexpression#setDataSourceExpr(org.codehaus.groovy.ast.expr.Expression))` \| \| `class [AbstractGinqExpression](abstractginqexpression)` \| `[accept](abstractginqexpression#accept(GinqAstVisitor)), [transformExpression](abstractginqexpression#transformExpression(org.codehaus.groovy.ast.expr.ExpressionTransformer)), [visit](abstractginqexpression#visit(org.codehaus.groovy.ast.GroovyCodeVisitor))` \| \| `class [Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[getType](../../../../../codehaus/groovy/ast/expr/expression#getType()), [setType](../../../../../codehaus/groovy/ast/expr/expression#setType(org.codehaus.groovy.ast.ClassNode)), [transformExpression](../../../../../codehaus/groovy/ast/expr/expression#transformExpression(org.codehaus.groovy.ast.expr.ExpressionTransformer)), [transformExpressions](../../../../../codehaus/groovy/ast/expr/expression#transformExpressions(List,%20org.codehaus.groovy.ast.expr.ExpressionTransformer)), [transformExpressions](../../../../../codehaus/groovy/ast/expr/expression#transformExpressions(List,%20org.codehaus.groovy.ast.expr.ExpressionTransformer,%20Class))` \| \| `class [AnnotatedNode](../../../../../codehaus/groovy/ast/annotatednode)` \| `[addAnnotation](../../../../../codehaus/groovy/ast/annotatednode#addAnnotation(org.codehaus.groovy.ast.AnnotationNode)), [addAnnotations](../../../../../codehaus/groovy/ast/annotatednode#addAnnotations(List)), [getAnnotations](../../../../../codehaus/groovy/ast/annotatednode#getAnnotations()), [getAnnotations](../../../../../codehaus/groovy/ast/annotatednode#getAnnotations(org.codehaus.groovy.ast.ClassNode)), [getDeclaringClass](../../../../../codehaus/groovy/ast/annotatednode#getDeclaringClass()), [getGroovydoc](../../../../../codehaus/groovy/ast/annotatednode#getGroovydoc()), [getInstance](../../../../../codehaus/groovy/ast/annotatednode#getInstance()), [hasNoRealSourcePosition](../../../../../codehaus/groovy/ast/annotatednode#hasNoRealSourcePosition()), [isSynthetic](../../../../../codehaus/groovy/ast/annotatednode#isSynthetic()), [setDeclaringClass](../../../../../codehaus/groovy/ast/annotatednode#setDeclaringClass(org.codehaus.groovy.ast.ClassNode)), [setHasNoRealSourcePosition](../../../../../codehaus/groovy/ast/annotatednode#setHasNoRealSourcePosition(boolean)), [setSynthetic](../../../../../codehaus/groovy/ast/annotatednode#setSynthetic(boolean))` \| \| `class [ASTNode](../../../../../codehaus/groovy/ast/astnode)` \| `[copyNodeMetaData](../../../../../codehaus/groovy/ast/astnode#copyNodeMetaData(org.codehaus.groovy.ast.ASTNode)), [getColumnNumber](../../../../../codehaus/groovy/ast/astnode#getColumnNumber()), [getLastColumnNumber](../../../../../codehaus/groovy/ast/astnode#getLastColumnNumber()), [getLastLineNumber](../../../../../codehaus/groovy/ast/astnode#getLastLineNumber()), [getLineNumber](../../../../../codehaus/groovy/ast/astnode#getLineNumber()), [getMetaDataMap](../../../../../codehaus/groovy/ast/astnode#getMetaDataMap()), [getText](../../../../../codehaus/groovy/ast/astnode#getText()), [setColumnNumber](../../../../../codehaus/groovy/ast/astnode#setColumnNumber(int)), [setLastColumnNumber](../../../../../codehaus/groovy/ast/astnode#setLastColumnNumber(int)), [setLastLineNumber](../../../../../codehaus/groovy/ast/astnode#setLastLineNumber(int)), [setLineNumber](../../../../../codehaus/groovy/ast/astnode#setLineNumber(int)), [setMetaDataMap](../../../../../codehaus/groovy/ast/astnode#setMetaDataMap(Map)), [setSourcePosition](../../../../../codehaus/groovy/ast/astnode#setSourcePosition(org.codehaus.groovy.ast.ASTNode)), [visit](../../../../../codehaus/groovy/ast/astnode#visit(org.codehaus.groovy.ast.GroovyCodeVisitor))` \| Constructor Detail ------------------ ### public FromExpression([Expression](../../../../../codehaus/groovy/ast/expr/expression) aliasExpr, [Expression](../../../../../codehaus/groovy/ast/expr/expression) dataSourceExpr) Method Detail ------------- ### <R> @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public R accept([GinqAstVisitor](../ginqastvisitor "GinqAstVisitor")<R> visitor) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [DataSourceExpression](datasourceexpression) getDataSourceExpression() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getText() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void setDataSourceExpression([DataSourceExpression](datasourceexpression) dataSourceExpression) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") toString()	programming_docs
groovy [Java] Class OrderExpression [Java] Class OrderExpression ============================ * org.apache.groovy.ginq.dsl.expression.OrderExpression ``` public class OrderExpression extends [ProcessExpression](processexpression) ``` Represents order by expression Since: 4.0.0 Inherited fields \| Fields inherited from class \| Fields \| \| `class [Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[EMPTY\_ARRAY](../../../../../codehaus/groovy/ast/expr/expression#EMPTY_ARRAY)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[OrderExpression](#OrderExpression(org.codehaus.groovy.ast.expr.Expression))([Expression](../../../../../codehaus/groovy/ast/expr/expression) ordersExpr)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| `<R>` \| `public R` \| `[accept](#accept(GinqAstVisitor))([GinqAstVisitor](../ginqastvisitor "GinqAstVisitor")<R> visitor)` \| \| \| `public [Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[getOrdersExpr](#getOrdersExpr())()` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getText](#getText())()` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[toString](#toString())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [ProcessExpression](processexpression)` \| `[getDataSourceExpression](processexpression#getDataSourceExpression()), [setDataSourceExpression](processexpression#setDataSourceExpression(org.apache.groovy.ginq.dsl.expression.DataSourceExpression))` \| \| `class [AbstractGinqExpression](abstractginqexpression)` \| `[accept](abstractginqexpression#accept(GinqAstVisitor)), [transformExpression](abstractginqexpression#transformExpression(org.codehaus.groovy.ast.expr.ExpressionTransformer)), [visit](abstractginqexpression#visit(org.codehaus.groovy.ast.GroovyCodeVisitor))` \| \| `class [Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[getType](../../../../../codehaus/groovy/ast/expr/expression#getType()), [setType](../../../../../codehaus/groovy/ast/expr/expression#setType(org.codehaus.groovy.ast.ClassNode)), [transformExpression](../../../../../codehaus/groovy/ast/expr/expression#transformExpression(org.codehaus.groovy.ast.expr.ExpressionTransformer)), [transformExpressions](../../../../../codehaus/groovy/ast/expr/expression#transformExpressions(List,%20org.codehaus.groovy.ast.expr.ExpressionTransformer)), [transformExpressions](../../../../../codehaus/groovy/ast/expr/expression#transformExpressions(List,%20org.codehaus.groovy.ast.expr.ExpressionTransformer,%20Class))` \| \| `class [AnnotatedNode](../../../../../codehaus/groovy/ast/annotatednode)` \| `[addAnnotation](../../../../../codehaus/groovy/ast/annotatednode#addAnnotation(org.codehaus.groovy.ast.AnnotationNode)), [addAnnotations](../../../../../codehaus/groovy/ast/annotatednode#addAnnotations(List)), [getAnnotations](../../../../../codehaus/groovy/ast/annotatednode#getAnnotations()), [getAnnotations](../../../../../codehaus/groovy/ast/annotatednode#getAnnotations(org.codehaus.groovy.ast.ClassNode)), [getDeclaringClass](../../../../../codehaus/groovy/ast/annotatednode#getDeclaringClass()), [getGroovydoc](../../../../../codehaus/groovy/ast/annotatednode#getGroovydoc()), [getInstance](../../../../../codehaus/groovy/ast/annotatednode#getInstance()), [hasNoRealSourcePosition](../../../../../codehaus/groovy/ast/annotatednode#hasNoRealSourcePosition()), [isSynthetic](../../../../../codehaus/groovy/ast/annotatednode#isSynthetic()), [setDeclaringClass](../../../../../codehaus/groovy/ast/annotatednode#setDeclaringClass(org.codehaus.groovy.ast.ClassNode)), [setHasNoRealSourcePosition](../../../../../codehaus/groovy/ast/annotatednode#setHasNoRealSourcePosition(boolean)), [setSynthetic](../../../../../codehaus/groovy/ast/annotatednode#setSynthetic(boolean))` \| \| `class [ASTNode](../../../../../codehaus/groovy/ast/astnode)` \| `[copyNodeMetaData](../../../../../codehaus/groovy/ast/astnode#copyNodeMetaData(org.codehaus.groovy.ast.ASTNode)), [getColumnNumber](../../../../../codehaus/groovy/ast/astnode#getColumnNumber()), [getLastColumnNumber](../../../../../codehaus/groovy/ast/astnode#getLastColumnNumber()), [getLastLineNumber](../../../../../codehaus/groovy/ast/astnode#getLastLineNumber()), [getLineNumber](../../../../../codehaus/groovy/ast/astnode#getLineNumber()), [getMetaDataMap](../../../../../codehaus/groovy/ast/astnode#getMetaDataMap()), [getText](../../../../../codehaus/groovy/ast/astnode#getText()), [setColumnNumber](../../../../../codehaus/groovy/ast/astnode#setColumnNumber(int)), [setLastColumnNumber](../../../../../codehaus/groovy/ast/astnode#setLastColumnNumber(int)), [setLastLineNumber](../../../../../codehaus/groovy/ast/astnode#setLastLineNumber(int)), [setLineNumber](../../../../../codehaus/groovy/ast/astnode#setLineNumber(int)), [setMetaDataMap](../../../../../codehaus/groovy/ast/astnode#setMetaDataMap(Map)), [setSourcePosition](../../../../../codehaus/groovy/ast/astnode#setSourcePosition(org.codehaus.groovy.ast.ASTNode)), [visit](../../../../../codehaus/groovy/ast/astnode#visit(org.codehaus.groovy.ast.GroovyCodeVisitor))` \| Constructor Detail ------------------ ### public OrderExpression([Expression](../../../../../codehaus/groovy/ast/expr/expression) ordersExpr) Method Detail ------------- ### <R> @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public R accept([GinqAstVisitor](../ginqastvisitor "GinqAstVisitor")<R> visitor) ### public [Expression](../../../../../codehaus/groovy/ast/expr/expression) getOrdersExpr() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getText() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") toString() groovy [Java] Class AbstractGinqExpression [Java] Class AbstractGinqExpression =================================== * org.apache.groovy.ginq.dsl.expression.AbstractGinqExpression All Implemented Interfaces and Traits: [NodeMetaDataHandler](../../../../../codehaus/groovy/ast/nodemetadatahandler) ``` public abstract class AbstractGinqExpression extends [Expression](../../../../../codehaus/groovy/ast/expr/expression) implements [NodeMetaDataHandler](../../../../../codehaus/groovy/ast/nodemetadatahandler) ``` Represents GINQ expression which could hold meta data Since: 4.0.0 Inherited fields \| Fields inherited from class \| Fields \| \| `class [Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[EMPTY\_ARRAY](../../../../../codehaus/groovy/ast/expr/expression#EMPTY_ARRAY)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| `<R>` \| `public abstract R` \| `[accept](#accept(GinqAstVisitor))([GinqAstVisitor](../ginqastvisitor "GinqAstVisitor")<R> visitor)` \| \| \| `public [Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[transformExpression](#transformExpression(org.codehaus.groovy.ast.expr.ExpressionTransformer))([ExpressionTransformer](../../../../../codehaus/groovy/ast/expr/expressiontransformer) transformer)` \| \| \| `public void` \| `[visit](#visit(org.codehaus.groovy.ast.GroovyCodeVisitor))([GroovyCodeVisitor](../../../../../codehaus/groovy/ast/groovycodevisitor) visitor)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[getType](../../../../../codehaus/groovy/ast/expr/expression#getType()), [setType](../../../../../codehaus/groovy/ast/expr/expression#setType(org.codehaus.groovy.ast.ClassNode)), [transformExpression](../../../../../codehaus/groovy/ast/expr/expression#transformExpression(org.codehaus.groovy.ast.expr.ExpressionTransformer)), [transformExpressions](../../../../../codehaus/groovy/ast/expr/expression#transformExpressions(List,%20org.codehaus.groovy.ast.expr.ExpressionTransformer)), [transformExpressions](../../../../../codehaus/groovy/ast/expr/expression#transformExpressions(List,%20org.codehaus.groovy.ast.expr.ExpressionTransformer,%20Class))` \| \| `class [AnnotatedNode](../../../../../codehaus/groovy/ast/annotatednode)` \| `[addAnnotation](../../../../../codehaus/groovy/ast/annotatednode#addAnnotation(org.codehaus.groovy.ast.AnnotationNode)), [addAnnotations](../../../../../codehaus/groovy/ast/annotatednode#addAnnotations(List)), [getAnnotations](../../../../../codehaus/groovy/ast/annotatednode#getAnnotations()), [getAnnotations](../../../../../codehaus/groovy/ast/annotatednode#getAnnotations(org.codehaus.groovy.ast.ClassNode)), [getDeclaringClass](../../../../../codehaus/groovy/ast/annotatednode#getDeclaringClass()), [getGroovydoc](../../../../../codehaus/groovy/ast/annotatednode#getGroovydoc()), [getInstance](../../../../../codehaus/groovy/ast/annotatednode#getInstance()), [hasNoRealSourcePosition](../../../../../codehaus/groovy/ast/annotatednode#hasNoRealSourcePosition()), [isSynthetic](../../../../../codehaus/groovy/ast/annotatednode#isSynthetic()), [setDeclaringClass](../../../../../codehaus/groovy/ast/annotatednode#setDeclaringClass(org.codehaus.groovy.ast.ClassNode)), [setHasNoRealSourcePosition](../../../../../codehaus/groovy/ast/annotatednode#setHasNoRealSourcePosition(boolean)), [setSynthetic](../../../../../codehaus/groovy/ast/annotatednode#setSynthetic(boolean))` \| \| `class [ASTNode](../../../../../codehaus/groovy/ast/astnode)` \| `[copyNodeMetaData](../../../../../codehaus/groovy/ast/astnode#copyNodeMetaData(org.codehaus.groovy.ast.ASTNode)), [getColumnNumber](../../../../../codehaus/groovy/ast/astnode#getColumnNumber()), [getLastColumnNumber](../../../../../codehaus/groovy/ast/astnode#getLastColumnNumber()), [getLastLineNumber](../../../../../codehaus/groovy/ast/astnode#getLastLineNumber()), [getLineNumber](../../../../../codehaus/groovy/ast/astnode#getLineNumber()), [getMetaDataMap](../../../../../codehaus/groovy/ast/astnode#getMetaDataMap()), [getText](../../../../../codehaus/groovy/ast/astnode#getText()), [setColumnNumber](../../../../../codehaus/groovy/ast/astnode#setColumnNumber(int)), [setLastColumnNumber](../../../../../codehaus/groovy/ast/astnode#setLastColumnNumber(int)), [setLastLineNumber](../../../../../codehaus/groovy/ast/astnode#setLastLineNumber(int)), [setLineNumber](../../../../../codehaus/groovy/ast/astnode#setLineNumber(int)), [setMetaDataMap](../../../../../codehaus/groovy/ast/astnode#setMetaDataMap(Map)), [setSourcePosition](../../../../../codehaus/groovy/ast/astnode#setSourcePosition(org.codehaus.groovy.ast.ASTNode)), [visit](../../../../../codehaus/groovy/ast/astnode#visit(org.codehaus.groovy.ast.GroovyCodeVisitor))` \| Method Detail ------------- ### <R> public abstract R accept([GinqAstVisitor](../ginqastvisitor "GinqAstVisitor")<R> visitor) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Expression](../../../../../codehaus/groovy/ast/expr/expression) transformExpression([ExpressionTransformer](../../../../../codehaus/groovy/ast/expr/expressiontransformer) transformer) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void visit([GroovyCodeVisitor](../../../../../codehaus/groovy/ast/groovycodevisitor) visitor) groovy [Java] Class LimitExpression [Java] Class LimitExpression ============================ * org.apache.groovy.ginq.dsl.expression.LimitExpression ``` public class LimitExpression extends [ProcessExpression](processexpression) ``` Represents limit expression Since: 4.0.0 Inherited fields \| Fields inherited from class \| Fields \| \| `class [Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[EMPTY\_ARRAY](../../../../../codehaus/groovy/ast/expr/expression#EMPTY_ARRAY)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[LimitExpression](#LimitExpression(org.codehaus.groovy.ast.expr.Expression))([Expression](../../../../../codehaus/groovy/ast/expr/expression) offsetAndSizeExpr)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| `<R>` \| `public R` \| `[accept](#accept(GinqAstVisitor))([GinqAstVisitor](../ginqastvisitor "GinqAstVisitor")<R> visitor)` \| \| \| `public [Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[getOffsetAndSizeExpr](#getOffsetAndSizeExpr())()` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getText](#getText())()` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[toString](#toString())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [ProcessExpression](processexpression)` \| `[getDataSourceExpression](processexpression#getDataSourceExpression()), [setDataSourceExpression](processexpression#setDataSourceExpression(org.apache.groovy.ginq.dsl.expression.DataSourceExpression))` \| \| `class [AbstractGinqExpression](abstractginqexpression)` \| `[accept](abstractginqexpression#accept(GinqAstVisitor)), [transformExpression](abstractginqexpression#transformExpression(org.codehaus.groovy.ast.expr.ExpressionTransformer)), [visit](abstractginqexpression#visit(org.codehaus.groovy.ast.GroovyCodeVisitor))` \| \| `class [Expression](../../../../../codehaus/groovy/ast/expr/expression)` \| `[getType](../../../../../codehaus/groovy/ast/expr/expression#getType()), [setType](../../../../../codehaus/groovy/ast/expr/expression#setType(org.codehaus.groovy.ast.ClassNode)), [transformExpression](../../../../../codehaus/groovy/ast/expr/expression#transformExpression(org.codehaus.groovy.ast.expr.ExpressionTransformer)), [transformExpressions](../../../../../codehaus/groovy/ast/expr/expression#transformExpressions(List,%20org.codehaus.groovy.ast.expr.ExpressionTransformer)), [transformExpressions](../../../../../codehaus/groovy/ast/expr/expression#transformExpressions(List,%20org.codehaus.groovy.ast.expr.ExpressionTransformer,%20Class))` \| \| `class [AnnotatedNode](../../../../../codehaus/groovy/ast/annotatednode)` \| `[addAnnotation](../../../../../codehaus/groovy/ast/annotatednode#addAnnotation(org.codehaus.groovy.ast.AnnotationNode)), [addAnnotations](../../../../../codehaus/groovy/ast/annotatednode#addAnnotations(List)), [getAnnotations](../../../../../codehaus/groovy/ast/annotatednode#getAnnotations()), [getAnnotations](../../../../../codehaus/groovy/ast/annotatednode#getAnnotations(org.codehaus.groovy.ast.ClassNode)), [getDeclaringClass](../../../../../codehaus/groovy/ast/annotatednode#getDeclaringClass()), [getGroovydoc](../../../../../codehaus/groovy/ast/annotatednode#getGroovydoc()), [getInstance](../../../../../codehaus/groovy/ast/annotatednode#getInstance()), [hasNoRealSourcePosition](../../../../../codehaus/groovy/ast/annotatednode#hasNoRealSourcePosition()), [isSynthetic](../../../../../codehaus/groovy/ast/annotatednode#isSynthetic()), [setDeclaringClass](../../../../../codehaus/groovy/ast/annotatednode#setDeclaringClass(org.codehaus.groovy.ast.ClassNode)), [setHasNoRealSourcePosition](../../../../../codehaus/groovy/ast/annotatednode#setHasNoRealSourcePosition(boolean)), [setSynthetic](../../../../../codehaus/groovy/ast/annotatednode#setSynthetic(boolean))` \| \| `class [ASTNode](../../../../../codehaus/groovy/ast/astnode)` \| `[copyNodeMetaData](../../../../../codehaus/groovy/ast/astnode#copyNodeMetaData(org.codehaus.groovy.ast.ASTNode)), [getColumnNumber](../../../../../codehaus/groovy/ast/astnode#getColumnNumber()), [getLastColumnNumber](../../../../../codehaus/groovy/ast/astnode#getLastColumnNumber()), [getLastLineNumber](../../../../../codehaus/groovy/ast/astnode#getLastLineNumber()), [getLineNumber](../../../../../codehaus/groovy/ast/astnode#getLineNumber()), [getMetaDataMap](../../../../../codehaus/groovy/ast/astnode#getMetaDataMap()), [getText](../../../../../codehaus/groovy/ast/astnode#getText()), [setColumnNumber](../../../../../codehaus/groovy/ast/astnode#setColumnNumber(int)), [setLastColumnNumber](../../../../../codehaus/groovy/ast/astnode#setLastColumnNumber(int)), [setLastLineNumber](../../../../../codehaus/groovy/ast/astnode#setLastLineNumber(int)), [setLineNumber](../../../../../codehaus/groovy/ast/astnode#setLineNumber(int)), [setMetaDataMap](../../../../../codehaus/groovy/ast/astnode#setMetaDataMap(Map)), [setSourcePosition](../../../../../codehaus/groovy/ast/astnode#setSourcePosition(org.codehaus.groovy.ast.ASTNode)), [visit](../../../../../codehaus/groovy/ast/astnode#visit(org.codehaus.groovy.ast.GroovyCodeVisitor))` \| Constructor Detail ------------------ ### public LimitExpression([Expression](../../../../../codehaus/groovy/ast/expr/expression) offsetAndSizeExpr) Method Detail ------------- ### <R> @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public R accept([GinqAstVisitor](../ginqastvisitor "GinqAstVisitor")<R> visitor) ### public [Expression](../../../../../codehaus/groovy/ast/expr/expression) getOffsetAndSizeExpr() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getText() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") toString() groovy [Java] Class DateUtilStaticExtensions [Java] Class DateUtilStaticExtensions ===================================== * org.apache.groovy.dateutil.extensions.DateUtilStaticExtensions ``` public class DateUtilStaticExtensions extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` This class defines new groovy static methods which appear on normal JDK Date and Calendar classes inside the Groovy environment. Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public static [Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date")` \| `[parse](#parse(java.util.Date,%20java.lang.String,%20java.lang.String))([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") format, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") input)`Parse a String into a Date instance using the given pattern. \| \| \| `public static [Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date")` \| `[parse](#parse(java.util.Date,%20java.lang.String,%20java.lang.String,%20java.util.TimeZone))([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") format, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") input, [TimeZone](https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html "TimeZone") zone)`Parse a String into a Date instance using the given pattern and TimeZone. \| \| \| `public static [Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date")` \| `[parseToStringDate](#parseToStringDate(java.util.Date,%20java.lang.String))([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") dateToString)`Parse a String matching the pattern EEE MMM dd HH:mm:ss zzz yyyy containing US-locale-constants only (e.g. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### public static [Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") parse([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") format, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") input) Parse a String into a Date instance using the given pattern. This convenience method acts as a wrapper for [SimpleDateFormat](https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html "SimpleDateFormat"). Note that a new SimpleDateFormat instance is created for every invocation of this method (for thread safety). throws: ParseException if there is a parse error Parameters: `self` - placeholder variable used by Groovy categories; ignored for default static methods `format` - pattern used to parse the input string. `input` - String to be parsed to create the date instance Returns: a new Date instance representing the parsed input string See Also: [SimpleDateFormat.parse](https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html#parse(java.lang.String) "SimpleDateFormat.parse") Since: 1.5.7 ### public static [Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") parse([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") format, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") input, [TimeZone](https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html "TimeZone") zone) Parse a String into a Date instance using the given pattern and TimeZone. This convenience method acts as a wrapper for [SimpleDateFormat](https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html "SimpleDateFormat"). Note that a new SimpleDateFormat instance is created for every invocation of this method (for thread safety). throws: ParseException if there is a parse error Parameters: `self` - placeholder variable used by Groovy categories; ignored for default static methods `format` - pattern used to parse the input string. `input` - String to be parsed to create the date instance `zone` - TimeZone to use when parsing Returns: a new Date instance representing the parsed input string See Also: [SimpleDateFormat.parse](https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html#parse(java.lang.String) "SimpleDateFormat.parse") Since: 2.4.1 ### public static [Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") parseToStringDate([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") dateToString) Parse a String matching the pattern EEE MMM dd HH:mm:ss zzz yyyy containing US-locale-constants only (e.g. Sat for Saturdays). Such a string is generated by the toString method of [Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") Note that a new SimpleDateFormat instance is created for every invocation of this method (for thread safety). throws: ParseException if there is a parse error Parameters: `self` - placeholder variable used by Groovy categories; ignored for default static methods `dateToString` - String to be parsed to create the date instance. Must match the pattern EEE MMM dd HH:mm:ss zzz yyyy with US-locale symbols Returns: a new Date instance representing the parsed input string Since: 1.8.4	programming_docs
groovy [Java] Class DateUtilExtensions [Java] Class DateUtilExtensions =============================== * org.apache.groovy.dateutil.extensions.DateUtilExtensions ``` public class DateUtilExtensions extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` This class defines new groovy methods which appear on normal JDK Date and Calendar classes inside the Groovy environment. Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public static [Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date")` \| `[clearTime](#clearTime(java.util.Date))([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") self)`Clears the time portion of this Date instance; useful utility where it makes sense to compare month/day/year only portions of a Date. \| \| \| `public static [Date](https://docs.oracle.com/javase/8/docs/api/java/sql/Date.html "Date")` \| `[clearTime](#clearTime(java.sql.Date))([Date](https://docs.oracle.com/javase/8/docs/api/java/sql/Date.html "Date") self)`Clears the time portion of this java.sql.Date instance; useful utility where it makes sense to compare month/day/year only portions of a Date. \| \| \| `public static [Calendar](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html "Calendar")` \| `[clearTime](#clearTime(java.util.Calendar))([Calendar](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html "Calendar") self)`Clears the time portion of this Calendar instance; useful utility where it makes sense to compare month/day/year only portions of a Calendar. \| \| \| `public static [Calendar](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html "Calendar")` \| `[copyWith](#copyWith(java.util.Calendar,%20Map))([Calendar](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html "Calendar") self, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object"), [Integer](https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html "Integer")> updates)`Support creating a new Date having similar properties to an existing Date (which remains unaltered) but with some fields updated according to a Map of changes. \| \| \| `public static [Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date")` \| `[copyWith](#copyWith(java.util.Date,%20Map))([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") self, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object"), [Integer](https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html "Integer")> updates)`Support creating a new Date having similar properties to an existing Date (which remains unaltered) but with some fields updated according to a Map of changes. \| \| \| `public static void` \| `[downto](#downto(java.util.Date,%20java.util.Date,%20groovy.lang.Closure))([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") self, [Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") to, [Closure](../../../../../groovy/lang/closure) closure)`Iterates from this date down to the given date, inclusive, decrementing by one day each time. \| \| \| `public static void` \| `[downto](#downto(java.util.Calendar,%20java.util.Calendar,%20groovy.lang.Closure))([Calendar](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html "Calendar") self, [Calendar](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html "Calendar") to, [Closure](../../../../../groovy/lang/closure) closure)`Iterates from the date represented by this calendar up to the date represented by the given calendar, inclusive, incrementing by one day each time. \| \| \| `public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[format](#format(java.util.Date,%20java.lang.String))([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") format)` \| \| \| `public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[format](#format(java.util.Date,%20java.lang.String,%20java.util.TimeZone))([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") format, [TimeZone](https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html "TimeZone") tz)` \| \| \| `public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[format](#format(java.util.Calendar,%20java.lang.String))([Calendar](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html "Calendar") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") pattern)` \| \| \| `public static int` \| `[getAt](#getAt(java.util.Date,%20int))([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") self, int field)`Support the subscript operator for a Date. \| \| \| `public static int` \| `[getAt](#getAt(java.util.Calendar,%20int))([Calendar](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html "Calendar") self, int field)`Support the subscript operator for a Calendar. \| \| \| `public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getDateString](#getDateString(java.util.Date))([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") self)` \| \| \| `public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getDateTimeString](#getDateTimeString(java.util.Date))([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") self)` \| \| \| `public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getTimeString](#getTimeString(java.util.Date))([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") self)` \| \| \| `public static [Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date")` \| `[minus](#minus(java.util.Date,%20int))([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") self, int days)`Subtract a number of days from this date and returns the new date. \| \| \| `public static [Date](https://docs.oracle.com/javase/8/docs/api/java/sql/Date.html "Date")` \| `[minus](#minus(java.sql.Date,%20int))([Date](https://docs.oracle.com/javase/8/docs/api/java/sql/Date.html "Date") self, int days)`Subtract a number of days from this date and returns the new date. \| \| \| `public static [Timestamp](https://docs.oracle.com/javase/8/docs/api/java/sql/Timestamp.html "Timestamp")` \| `[minus](#minus(java.sql.Timestamp,%20int))([Timestamp](https://docs.oracle.com/javase/8/docs/api/java/sql/Timestamp.html "Timestamp") self, int days)`Subtract a number of days from this Timestamp and returns the new Timestamp object. \| \| \| `public static int` \| `[minus](#minus(java.util.Calendar,%20java.util.Calendar))([Calendar](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html "Calendar") self, [Calendar](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html "Calendar") then)`Subtract another date from this one and return the number of days of the difference. \| \| \| `public static int` \| `[minus](#minus(java.util.Date,%20java.util.Date))([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") self, [Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") then)`Subtract another Date from this one and return the number of days of the difference. \| \| \| `public static [Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date")` \| `[next](#next(java.util.Date))([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") self)`Increment a Date by one day. \| \| \| `public static [Calendar](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html "Calendar")` \| `[next](#next(java.util.Calendar))([Calendar](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html "Calendar") self)`Increment a Calendar by one day. \| \| \| `public static [Date](https://docs.oracle.com/javase/8/docs/api/java/sql/Date.html "Date")` \| `[next](#next(java.sql.Date))([Date](https://docs.oracle.com/javase/8/docs/api/java/sql/Date.html "Date") self)`Increment a java.sql.Date by one day. \| \| \| `public static [Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date")` \| `[plus](#plus(java.util.Date,%20int))([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") self, int days)`Add a number of days to this date and returns the new date. \| \| \| `public static [Date](https://docs.oracle.com/javase/8/docs/api/java/sql/Date.html "Date")` \| `[plus](#plus(java.sql.Date,%20int))([Date](https://docs.oracle.com/javase/8/docs/api/java/sql/Date.html "Date") self, int days)`Add a number of days to this date and returns the new date. \| \| \| `public static [Timestamp](https://docs.oracle.com/javase/8/docs/api/java/sql/Timestamp.html "Timestamp")` \| `[plus](#plus(java.sql.Timestamp,%20int))([Timestamp](https://docs.oracle.com/javase/8/docs/api/java/sql/Timestamp.html "Timestamp") self, int days)`Add number of days to this Timestamp and returns the new Timestamp object. \| \| \| `public static [Calendar](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html "Calendar")` \| `[previous](#previous(java.util.Calendar))([Calendar](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html "Calendar") self)`Decrement a Calendar by one day. \| \| \| `public static [Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date")` \| `[previous](#previous(java.util.Date))([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") self)`Decrement a Date by one day. \| \| \| `public static [Date](https://docs.oracle.com/javase/8/docs/api/java/sql/Date.html "Date")` \| `[previous](#previous(java.sql.Date))([Date](https://docs.oracle.com/javase/8/docs/api/java/sql/Date.html "Date") self)`Decrement a java.sql.Date by one day. \| \| \| `public static void` \| `[putAt](#putAt(java.util.Calendar,%20int,%20int))([Calendar](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html "Calendar") self, int field, int value)`Support the subscript operator for mutating a Calendar. \| \| \| `public static void` \| `[putAt](#putAt(java.util.Date,%20int,%20int))([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") self, int field, int value)`Support the subscript operator for mutating a Date. \| \| \| `public static void` \| `[set](#set(java.util.Calendar,%20Map))([Calendar](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html "Calendar") self, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object"), [Integer](https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html "Integer")> updates)`Support mutating a Calendar with a Map. \| \| \| `public static void` \| `[set](#set(java.util.Date,%20Map))([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") self, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object"), [Integer](https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html "Integer")> updates)`Support mutating a Date with a Map. \| \| \| `public static [Calendar](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html "Calendar")` \| `[toCalendar](#toCalendar(java.util.Date))([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") self)`Convert a Date to a Calendar. \| \| \| `public static [Calendar](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html "Calendar")` \| `[updated](#updated(java.util.Calendar,%20Map))([Calendar](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html "Calendar") self, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object"), [Integer](https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html "Integer")> updates)`Legacy alias for copyWith. \| \| \| `public static [Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date")` \| `[updated](#updated(java.util.Date,%20Map))([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") self, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object"), [Integer](https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html "Integer")> updates)`Legacy alias for copyWith. \| \| \| `public static void` \| `[upto](#upto(java.util.Date,%20java.util.Date,%20groovy.lang.Closure))([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") self, [Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") to, [Closure](../../../../../groovy/lang/closure) closure)`Iterates from this date up to the given date, inclusive, incrementing by one day each time. \| \| \| `public static void` \| `[upto](#upto(java.util.Calendar,%20java.util.Calendar,%20groovy.lang.Closure))([Calendar](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html "Calendar") self, [Calendar](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html "Calendar") to, [Closure](../../../../../groovy/lang/closure) closure)`Iterates from the date represented by this calendar up to the date represented by the given calendar, inclusive, incrementing by one day each time. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### public static [Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") clearTime([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") self) Clears the time portion of this Date instance; useful utility where it makes sense to compare month/day/year only portions of a Date. Parameters: `self` - a Date Returns: the Date but with the time portion cleared Since: 1.6.7 ### public static [Date](https://docs.oracle.com/javase/8/docs/api/java/sql/Date.html "Date") clearTime([Date](https://docs.oracle.com/javase/8/docs/api/java/sql/Date.html "Date") self) Clears the time portion of this java.sql.Date instance; useful utility where it makes sense to compare month/day/year only portions of a Date. Parameters: `self` - a java.sql.Date Returns: the java.sql.Date but with the time portion cleared Since: 1.6.7 ### public static [Calendar](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html "Calendar") clearTime([Calendar](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html "Calendar") self) Clears the time portion of this Calendar instance; useful utility where it makes sense to compare month/day/year only portions of a Calendar. Parameters: `self` - a Calendar Returns: the Calendar but with the time portion cleared Since: 1.6.7 ### public static [Calendar](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html "Calendar") copyWith([Calendar](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html "Calendar") self, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object"), [Integer](https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html "Integer")> updates) Support creating a new Date having similar properties to an existing Date (which remains unaltered) but with some fields updated according to a Map of changes. Example usage: ``` import static java.util.Calendar.YEAR def now = Calendar.instance def nextYear = now[YEAR] + 1 def oneYearFromNow = now.copyWith(year: nextYear) println now.time println oneYearFromNow.time ``` Parameters: `self` - A Calendar `updates` - A Map of Calendar keys and values Returns: The newly created Calendar See Also: [Calendar.set](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html#set(int,%20int) "Calendar.set") [Calendar.set](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html#set(int,%20int,%20int,%20int,%20int,%20int) "Calendar.set") [set(java.util.Calendar, java.util.Map)](#set(java.util.Calendar,%20java.util.Map)) Since: 2.2.0 ### public static [Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") copyWith([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") self, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object"), [Integer](https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html "Integer")> updates) Support creating a new Date having similar properties to an existing Date (which remains unaltered) but with some fields updated according to a Map of changes. Example usage: ``` import static java.util.Calendar.YEAR def today = new Date() def nextYear = today[YEAR] + 1 def oneYearFromNow = today.copyWith(year: nextYear) println today println oneYearFromNow ``` Parameters: `self` - A Date `updates` - A Map of Calendar keys and values Returns: The newly created Date See Also: [Calendar.set](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html#set(int,%20int) "Calendar.set") [set(java.util.Date, java.util.Map)](#set(java.util.Date,%20java.util.Map)) [copyWith(java.util.Calendar, java.util.Map)](#copyWith(java.util.Calendar,%20java.util.Map)) Since: 2.2.0 ### public static void downto([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") self, [Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") to, [Closure](../../../../../groovy/lang/closure) closure) Iterates from this date down to the given date, inclusive, decrementing by one day each time. Parameters: `self` - a Date `to` - another Date to go down to `closure` - the closure to call Since: 2.2 ### public static void downto([Calendar](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html "Calendar") self, [Calendar](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html "Calendar") to, [Closure](../../../../../groovy/lang/closure) closure) Iterates from the date represented by this calendar up to the date represented by the given calendar, inclusive, incrementing by one day each time. Parameters: `self` - a Calendar `to` - another Calendar to go down to `closure` - the closure to call Since: 2.2 ### public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") format([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") format) Create a String representation of this date according to the given format pattern. For example, if the system timezone is GMT, `new Date(0).format('MM/dd/yy')` would return the string `"01/01/70"`. See documentation for [SimpleDateFormat](https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html "SimpleDateFormat") for format pattern use. Note that a new DateFormat instance is created for every invocation of this method (for thread safety). Parameters: `self` - a Date `format` - the format pattern to use according to [SimpleDateFormat](https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html "SimpleDateFormat") Returns: a string representation of this date. See Also: [SimpleDateFormat](https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html "SimpleDateFormat") Since: 1.5.7 ### public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") format([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") format, [TimeZone](https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html "TimeZone") tz) Create a String representation of this date according to the given format pattern and timezone. For example: `def d = new Date(0) def tz = TimeZone.getTimeZone('GMT') println d.format('dd/MMM/yyyy', tz)` would return the string `"01/Jan/1970"`. See documentation for [SimpleDateFormat](https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html "SimpleDateFormat") for format pattern use. Note that a new DateFormat instance is created for every invocation of this method (for thread safety). Parameters: `self` - a Date `format` - the format pattern to use according to [SimpleDateFormat](https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html "SimpleDateFormat") `tz` - the TimeZone to use Returns: a string representation of this date. See Also: [SimpleDateFormat](https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html "SimpleDateFormat") Since: 1.8.3 ### public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") format([Calendar](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html "Calendar") self, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") pattern) Shortcut for [SimpleDateFormat](https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html "SimpleDateFormat") to output a String representation of this calendar instance. This method respects the Calendar's assigned [TimeZone](https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html "TimeZone"), whereas calling `cal.time.format('HH:mm:ss')` would use the system timezone. Note that Calendar equivalents of `date.getDateString()` and variants do not exist because those methods are Locale-dependent. Although a Calendar may be assigned a [Locale](https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html "Locale"), that information is lost and therefore cannot be used to control the default date/time formats provided by these methods. Instead, the system Locale would always be used. The alternative is to simply call [DateFormat.getDateInstance](https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html#getDateInstance(int,%20java.util.Locale) "DateFormat.getDateInstance") and pass the same Locale that was used for the Calendar. Parameters: `self` - this calendar `pattern` - format pattern Returns: String representation of this calendar with the given format. See Also: [DateFormat.setTimeZone](https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html#setTimeZone(java.util.TimeZone) "DateFormat.setTimeZone") [SimpleDateFormat.format](https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html#format(java.util.Date) "SimpleDateFormat.format") [format(java.util.Date, String)](#format(java.util.Date,%20java.lang.String)) Since: 1.6.0 ### public static int getAt([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") self, int field) Support the subscript operator for a Date. Parameters: `self` - a Date `field` - a Calendar field, e.g. MONTH Returns: the value for the given field, e.g. FEBRUARY See Also: [Calendar](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html "Calendar") Since: 1.5.5 ### public static int getAt([Calendar](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html "Calendar") self, int field) Support the subscript operator for a Calendar. Parameters: `self` - a Calendar `field` - a Calendar field, e.g. MONTH Returns: the value for the given field, e.g. FEBRUARY See Also: [Calendar](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html "Calendar") Since: 1.7.3 ### public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getDateString([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") self) Return a string representation of the 'day' portion of this date according to the locale-specific [DateFormat.SHORT](https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html#SHORT "DateFormat.SHORT") default format. For an "en\_UK" system locale, this would be `dd/MM/yy`. Note that a new DateFormat instance is created for every invocation of this method (for thread safety). Parameters: `self` - a Date Returns: a string representation of this date See Also: [DateFormat.getDateInstance](https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html#getDateInstance(int) "DateFormat.getDateInstance") [DateFormat.SHORT](https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html#SHORT "DateFormat.SHORT") Since: 1.5.7 ### public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getDateTimeString([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") self) Return a string representation of the date and time time portion of this Date instance, according to the locale-specific format used by [DateFormat](https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html "DateFormat"). This method uses the [DateFormat.SHORT](https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html#SHORT "DateFormat.SHORT") preset for the day portion and [DateFormat.MEDIUM](https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html#MEDIUM "DateFormat.MEDIUM") for the time portion of the output string. Note that a new DateFormat instance is created for every invocation of this method (for thread safety). Parameters: `self` - a Date Returns: a string representation of this date and time See Also: [DateFormat.getDateTimeInstance](https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html#getDateTimeInstance(int,%20int) "DateFormat.getDateTimeInstance") Since: 1.5.7 ### public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getTimeString([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") self) Return a string representation of the time portion of this date according to the locale-specific [DateFormat.MEDIUM](https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html#MEDIUM "DateFormat.MEDIUM") default format. For an "en\_UK" system locale, this would be `HH:MM:ss`. Note that a new DateFormat instance is created for every invocation of this method (for thread safety). Parameters: `self` - a Date Returns: a string representing the time portion of this date See Also: [DateFormat.getTimeInstance](https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html#getTimeInstance(int) "DateFormat.getTimeInstance") [DateFormat.MEDIUM](https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html#MEDIUM "DateFormat.MEDIUM") Since: 1.5.7 ### public static [Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") minus([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") self, int days) Subtract a number of days from this date and returns the new date. Parameters: `self` - a Date `days` - the number of days to subtract Returns: the new date Since: 1.0 ### public static [Date](https://docs.oracle.com/javase/8/docs/api/java/sql/Date.html "Date") minus([Date](https://docs.oracle.com/javase/8/docs/api/java/sql/Date.html "Date") self, int days) Subtract a number of days from this date and returns the new date. Parameters: `self` - a java.sql.Date `days` - the number of days to subtract Returns: the new date Since: 1.0 ### public static [Timestamp](https://docs.oracle.com/javase/8/docs/api/java/sql/Timestamp.html "Timestamp") minus([Timestamp](https://docs.oracle.com/javase/8/docs/api/java/sql/Timestamp.html "Timestamp") self, int days) Subtract a number of days from this Timestamp and returns the new Timestamp object. Parameters: `self` - a Timestamp `days` - the number of days to subtract Returns: the new Timestamp ### public static int minus([Calendar](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html "Calendar") self, [Calendar](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html "Calendar") then) Subtract another date from this one and return the number of days of the difference. Date self = Date then + (Date self - Date then) IOW, if self is before then the result is a negative value. Parameters: `self` - a Calendar `then` - another Calendar Returns: number of days Since: 1.6.0 ### public static int minus([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") self, [Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") then) Subtract another Date from this one and return the number of days of the difference. Date self = Date then + (Date self - Date then) IOW, if self is before then the result is a negative value. Parameters: `self` - a Date `then` - another Date Returns: number of days Since: 1.6.0 ### public static [Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") next([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") self) Increment a Date by one day. Parameters: `self` - a Date Returns: the next days date Since: 1.0 ### public static [Calendar](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html "Calendar") next([Calendar](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html "Calendar") self) Increment a Calendar by one day. Parameters: `self` - a Calendar Returns: a new Calendar set to the next day Since: 1.8.7 ### public static [Date](https://docs.oracle.com/javase/8/docs/api/java/sql/Date.html "Date") next([Date](https://docs.oracle.com/javase/8/docs/api/java/sql/Date.html "Date") self) Increment a java.sql.Date by one day. Parameters: `self` - a java.sql.Date Returns: the next days date Since: 1.0 ### public static [Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") plus([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") self, int days) Add a number of days to this date and returns the new date. Parameters: `self` - a Date `days` - the number of days to increase Returns: the new date Since: 1.0 ### public static [Date](https://docs.oracle.com/javase/8/docs/api/java/sql/Date.html "Date") plus([Date](https://docs.oracle.com/javase/8/docs/api/java/sql/Date.html "Date") self, int days) Add a number of days to this date and returns the new date. Parameters: `self` - a java.sql.Date `days` - the number of days to increase Returns: the new date Since: 1.0 ### public static [Timestamp](https://docs.oracle.com/javase/8/docs/api/java/sql/Timestamp.html "Timestamp") plus([Timestamp](https://docs.oracle.com/javase/8/docs/api/java/sql/Timestamp.html "Timestamp") self, int days) Add number of days to this Timestamp and returns the new Timestamp object. Parameters: `self` - a Timestamp `days` - the number of days to increase Returns: the new Timestamp ### public static [Calendar](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html "Calendar") previous([Calendar](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html "Calendar") self) Decrement a Calendar by one day. Parameters: `self` - a Calendar Returns: a new Calendar set to the previous day Since: 1.8.7 ### public static [Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") previous([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") self) Decrement a Date by one day. Parameters: `self` - a Date Returns: the previous days date Since: 1.0 ### public static [Date](https://docs.oracle.com/javase/8/docs/api/java/sql/Date.html "Date") previous([Date](https://docs.oracle.com/javase/8/docs/api/java/sql/Date.html "Date") self) Decrement a java.sql.Date by one day. Parameters: `self` - a java.sql.Date Returns: the previous days date Since: 1.0 ### public static void putAt([Calendar](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html "Calendar") self, int field, int value) Support the subscript operator for mutating a Calendar. Example usage: ``` import static java.util.Calendar.* def cal = Calendar.instance cal[DAY_OF_WEEK] = MONDAY cal[MONTH] = MARCH println cal.time // A Monday in March ``` Parameters: `self` - A Calendar `field` - A Calendar field, e.g. MONTH `value` - The value for the given field, e.g. FEBRUARY See Also: [Calendar.set](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html#set(int,%20int) "Calendar.set") Since: 1.7.3 ### public static void putAt([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") self, int field, int value) Support the subscript operator for mutating a Date. Parameters: `self` - A Date `field` - A Calendar field, e.g. MONTH `value` - The value for the given field, e.g. FEBRUARY See Also: [putAt(java.util.Calendar, int, int)](#putAt(java.util.Calendar,%20int,%20int)) [Calendar.set](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html#set(int,%20int) "Calendar.set") Since: 1.7.3 ### public static void set([Calendar](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html "Calendar") self, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object"), [Integer](https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html "Integer")> updates) Support mutating a Calendar with a Map. The map values are the normal values provided as the second parameter to `java.util.Calendar#set(int, int)`. The keys can either be the normal fields values provided as the first parameter to that method or one of the following Strings: Calendar index values\| year \| Calendar.YEAR \| \| month \| Calendar.MONTH \| \| date \| Calendar.DATE \| \| dayOfMonth \| Calendar.DATE \| \| hourOfDay \| Calendar.HOUR\_OF\_DAY \| \| minute \| Calendar.MINUTE \| \| second \| Calendar.SECOND \| Example usage: ``` import static java.util.Calendar.* def cal = Calendar.instance def m = [:] m[YEAR] = 2010 m[MONTH] = DECEMBER m[DATE] = 25 cal.set(m) println cal.time // Christmas 2010 cal.set(year:2011, month:DECEMBER, date:25) println cal.time // Christmas 2010 ``` Parameters: `self` - A Calendar `updates` - A Map of Calendar keys and values See Also: [Calendar.set](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html#set(int,%20int) "Calendar.set") [Calendar.set](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html#set(int,%20int,%20int,%20int,%20int,%20int) "Calendar.set") Since: 1.7.3 ### public static void set([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") self, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object"), [Integer](https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html "Integer")> updates) Support mutating a Date with a Map. The map values are the normal values provided as the second parameter to `java.util.Calendar#set(int, int)`. The keys can either be the normal fields values provided as the first parameter to that method or one of the following Strings: Calendar index values\| year \| Calendar.YEAR \| \| month \| Calendar.MONTH \| \| date \| Calendar.DATE \| \| dayOfMonth \| Calendar.DATE \| \| hourOfDay \| Calendar.HOUR\_OF\_DAY \| \| minute \| Calendar.MINUTE \| \| second \| Calendar.SECOND \| Example usage: ``` import static java.util.Calendar.YEAR def date = new Date() def nextYear = date[YEAR] + 1 date.set(year: nextYear) println date ``` Parameters: `self` - A Date `updates` - A Map of Calendar keys and values See Also: [Calendar.set](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html#set(int,%20int) "Calendar.set") [set(java.util.Calendar, java.util.Map)](#set(java.util.Calendar,%20java.util.Map)) Since: 1.7.3 ### public static [Calendar](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html "Calendar") toCalendar([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") self) Convert a Date to a Calendar. Parameters: `self` - a Date Returns: a Calendar corresponding to the given Date Since: 1.7.6 ### public static [Calendar](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html "Calendar") updated([Calendar](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html "Calendar") self, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object"), [Integer](https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html "Integer")> updates) Legacy alias for copyWith. Will be deprecated and removed in future versions of Groovy. See Also: [copyWith(java.util.Calendar, java.util.Map)](#copyWith(java.util.Calendar,%20java.util.Map)) Since: 1.7.3 ### public static [Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") updated([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") self, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object"), [Integer](https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html "Integer")> updates) Legacy alias for copyWith. Will be deprecated and removed in future versions of Groovy. See Also: [copyWith(java.util.Date, java.util.Map)](#copyWith(java.util.Date,%20java.util.Map)) Since: 1.7.3 ### public static void upto([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") self, [Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") to, [Closure](../../../../../groovy/lang/closure) closure) Iterates from this date up to the given date, inclusive, incrementing by one day each time. Parameters: `self` - a Date `to` - another Date to go up to `closure` - the closure to call Since: 2.2 ### public static void upto([Calendar](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html "Calendar") self, [Calendar](https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html "Calendar") to, [Closure](../../../../../groovy/lang/closure) closure) Iterates from the date represented by this calendar up to the date represented by the given calendar, inclusive, incrementing by one day each time. Parameters: `self` - a Calendar `to` - another Calendar to go up to `closure` - the closure to call Since: 2.2	programming_docs
groovy [Java] Class SqlExtensions [Java] Class SqlExtensions ========================== * org.apache.groovy.sql.extensions.SqlExtensions ``` public class SqlExtensions extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` This class defines all the new SQL-related groovy methods which enhance the normal JDK SQL classes when inside the Groovy environment. Static methods are used with the first parameter the destination class. Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public static boolean` \| `[asBoolean](#asBoolean(groovy.sql.GroovyResultSet))([GroovyResultSet](../../../../../groovy/sql/groovyresultset) grs)`Coerce a GroovyResultSet to a boolean value. \| \| \| `public static [Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html "Iterator")<[ResultSetMetaDataWrapper](../../../../../groovy/sql/resultsetmetadatawrapper "ResultSetMetaDataWrapper")>` \| `[iterator](#iterator(java.sql.ResultSetMetaData))([ResultSetMetaData](https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSetMetaData.html "ResultSetMetaData") resultSetMetaData)`Return an Iterator given a ResultSetMetaData. \| \| \| `public static [GroovyRowResult](../../../../../groovy/sql/groovyrowresult)` \| `[toRowResult](#toRowResult(java.sql.ResultSet))([ResultSet](https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSet.html "ResultSet") rs)`Returns a GroovyRowResult given a ResultSet. \| \| \| `public static [Timestamp](https://docs.oracle.com/javase/8/docs/api/java/sql/Timestamp.html "Timestamp")` \| `[toTimestamp](#toTimestamp(java.util.Date))([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") d)`Return a java.sql.Timestamp given a java.util.Date. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### public static boolean asBoolean([GroovyResultSet](../../../../../groovy/sql/groovyresultset) grs) Coerce a GroovyResultSet to a boolean value. A GroovyResultSet is coerced to false if there are no more rows to iterate over, and to true otherwise. Parameters: `grs` - the GroovyResultSet Returns: the boolean value Since: 1.7.0 ### public static [Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html "Iterator")<[ResultSetMetaDataWrapper](../../../../../groovy/sql/resultsetmetadatawrapper "ResultSetMetaDataWrapper")> iterator([ResultSetMetaData](https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSetMetaData.html "ResultSetMetaData") resultSetMetaData) Return an Iterator given a ResultSetMetaData. Enables Groovy collection method syntactic sugar on ResultSetMetaData. Parameters: `resultSetMetaData` - the ResultSetMetaData to iterate over Returns: an iterator for the ResultSetMetaData Since: 1.7 ### public static [GroovyRowResult](../../../../../groovy/sql/groovyrowresult) toRowResult([ResultSet](https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSet.html "ResultSet") rs) Returns a GroovyRowResult given a ResultSet. throws: java.sql.SQLException if a database error occurs Parameters: `rs` - a ResultSet Returns: the resulting GroovyRowResult Since: 1.6.0 ### public static [Timestamp](https://docs.oracle.com/javase/8/docs/api/java/sql/Timestamp.html "Timestamp") toTimestamp([Date](https://docs.oracle.com/javase/8/docs/api/java/util/Date.html "Date") d) Return a java.sql.Timestamp given a java.util.Date. Parameters: `d` - a date Returns: the date wrapped as a Timestamp Since: 1.6.6 groovy [Java] Class AntBuilder [Java] Class AntBuilder ======================= * groovy.ant.AntBuilder ``` public class AntBuilder extends [BuilderSupport](../util/buildersupport) ``` Allows [Ant tasks](http://ant.apache.org/manual/coretasklist.html) to be used with a Groovy builder-style markup. Requires that {{ant.jar}} is on your classpath which will happen automatically if you are using the Groovy distribution but will be up to you to organize if you are embedding Groovy. If you wish to use the [optional tasks](http://ant.apache.org/manual/install#optionalTasks) you will need to add one or more additional jars from the ant distribution to your classpath - see the [library dependencies](http://ant.apache.org/manual/install.html#librarydependencies) for more details. Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[AntBuilder](#AntBuilder())()` \| \| `[AntBuilder](#AntBuilder(org.apache.tools.ant.Project))([Project](https://docs.groovy-lang.org/docs/ant/api/org/apache/tools/ant/Project.html "Project") project)` \| \| `[AntBuilder](#AntBuilder(org.apache.tools.ant.Project,%20org.apache.tools.ant.Target))([Project](https://docs.groovy-lang.org/docs/ant/api/org/apache/tools/ant/Project.html "Project") project, [Target](https://docs.groovy-lang.org/docs/ant/api/org/apache/tools/ant/Target.html "Target") owningTarget)` \| \| `[AntBuilder](#AntBuilder(org.apache.tools.ant.Task))([Task](https://docs.groovy-lang.org/docs/ant/api/org/apache/tools/ant/Task.html "Task") parentTask)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `protected static [Attributes](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/Attributes.html "Attributes")` \| `[buildAttributes](#buildAttributes(java.util.Map))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)`Builds an [Attributes](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/Attributes.html "Attributes") from a [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[createNode](#createNode(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") tagName)` \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[createNode](#createNode(java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[createNode](#createNode(java.lang.Object,%20java.util.Map,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[createNode](#createNode(java.lang.Object,%20java.util.Map))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| \| \| `protected static [Project](https://docs.groovy-lang.org/docs/ant/api/org/apache/tools/ant/Project.html "Project")` \| `[createProject](#createProject())()` Returns: Factory method to create new Project instances \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[doInvokeMethod](#doInvokeMethod(java.lang.String,%20java.lang.Object,%20java.lang.Object))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args)`We don't want to return the node as created in [createNode(Object, Map, Object)](#createNode(java.lang.Object,%20java.util.Map,%20java.lang.Object)) but the one made ready by [nodeCompleted(Object, Object)](#nodeCompleted(java.lang.Object,%20java.lang.Object)) \| \| \| `public [Project](https://docs.groovy-lang.org/docs/ant/api/org/apache/tools/ant/Project.html "Project")` \| `[getAntProject](#getAntProject())()` \| \| \| `public [AntXMLContext](https://docs.groovy-lang.org/docs/ant/api/org/apache/tools/ant/helper/AntXMLContext.html "AntXMLContext")` \| `[getAntXmlContext](#getAntXmlContext())()`Gets the xml context of Ant used while creating tasks \| \| \| `public [Project](https://docs.groovy-lang.org/docs/ant/api/org/apache/tools/ant/Project.html "Project")` \| `[getProject](#getProject())()`# Gets the Ant project in which the tasks are executed \| \| \| `public boolean` \| `[isSaveStreams](#isSaveStreams())()`Whether stdin, stdout, stderr streams are saved. \| \| \| `protected void` \| `[nodeCompleted](#nodeCompleted(java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node)`Determines, when the ANT Task that is represented by the "node" should perform. \| \| \| `protected void` \| `[setParent](#setParent(java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child)` \| \| \| `public void` \| `[setSaveStreams](#setSaveStreams(boolean))(boolean saveStreams)`Indicates that we save stdin, stdout, stderr and replace them while AntBuilder is executing tasks with streams that funnel the normal streams into Ant's logs. \| \| \| `protected void` \| `[setText](#setText(java.lang.Object,%20java.lang.String))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") task, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [BuilderSupport](../util/buildersupport)` \| `[createNode](../util/buildersupport#createNode(java.lang.Object)), [createNode](../util/buildersupport#createNode(java.lang.Object,%20java.lang.Object)), [createNode](../util/buildersupport#createNode(java.lang.Object,%20java.util.Map)), [createNode](../util/buildersupport#createNode(java.lang.Object,%20java.util.Map,%20java.lang.Object)), [doInvokeMethod](../util/buildersupport#doInvokeMethod(java.lang.String,%20java.lang.Object,%20java.lang.Object)), [getCurrent](../util/buildersupport#getCurrent()), [getName](../util/buildersupport#getName(java.lang.String)), [invokeMethod](../util/buildersupport#invokeMethod(java.lang.String)), [invokeMethod](../util/buildersupport#invokeMethod(java.lang.String,%20java.lang.Object)), [nodeCompleted](../util/buildersupport#nodeCompleted(java.lang.Object,%20java.lang.Object)), [postNodeCompletion](../util/buildersupport#postNodeCompletion(java.lang.Object,%20java.lang.Object)), [setClosureDelegate](../util/buildersupport#setClosureDelegate(groovy.lang.Closure,%20java.lang.Object)), [setCurrent](../util/buildersupport#setCurrent(java.lang.Object)), [setParent](../util/buildersupport#setParent(java.lang.Object,%20java.lang.Object))` \| \| `class [GroovyObjectSupport](../lang/groovyobjectsupport)` \| `[getMetaClass](../lang/groovyobjectsupport#getMetaClass()), [setMetaClass](../lang/groovyobjectsupport#setMetaClass(groovy.lang.MetaClass))` \| Constructor Detail ------------------ ### public AntBuilder() ### public AntBuilder([Project](https://docs.groovy-lang.org/docs/ant/api/org/apache/tools/ant/Project.html "Project") project) ### public AntBuilder([Project](https://docs.groovy-lang.org/docs/ant/api/org/apache/tools/ant/Project.html "Project") project, [Target](https://docs.groovy-lang.org/docs/ant/api/org/apache/tools/ant/Target.html "Target") owningTarget) ### public AntBuilder([Task](https://docs.groovy-lang.org/docs/ant/api/org/apache/tools/ant/Task.html "Task") parentTask) Method Detail ------------- ### protected static [Attributes](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/Attributes.html "Attributes") buildAttributes([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) Builds an [Attributes](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/Attributes.html "Attributes") from a [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") Parameters: `attributes` - the attributes to wrap Returns: the wrapped attributes ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") createNode([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") tagName) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") createNode([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") createNode([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") createNode([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) ### protected static [Project](https://docs.groovy-lang.org/docs/ant/api/org/apache/tools/ant/Project.html "Project") createProject() Returns: Factory method to create new Project instances ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") doInvokeMethod([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args) We don't want to return the node as created in [createNode(Object, Map, Object)](#createNode(java.lang.Object,%20java.util.Map,%20java.lang.Object)) but the one made ready by [nodeCompleted(Object, Object)](#nodeCompleted(java.lang.Object,%20java.lang.Object)) See Also: [BuilderSupport.doInvokeMethod](../util/buildersupport#doInvokeMethod(java.lang.String,%20java.lang.Object,%20java.lang.Object) "BuilderSupport.doInvokeMethod") ### public [Project](https://docs.groovy-lang.org/docs/ant/api/org/apache/tools/ant/Project.html "Project") getAntProject() ### public [AntXMLContext](https://docs.groovy-lang.org/docs/ant/api/org/apache/tools/ant/helper/AntXMLContext.html "AntXMLContext") getAntXmlContext() Gets the xml context of Ant used while creating tasks Returns: the Ant xml context ### public [Project](https://docs.groovy-lang.org/docs/ant/api/org/apache/tools/ant/Project.html "Project") getProject() # Gets the Ant project in which the tasks are executed Returns: the project ### public boolean isSaveStreams() Whether stdin, stdout, stderr streams are saved. Returns: true if we are saving streams See Also: [setSaveStreams(boolean)](#setSaveStreams(boolean)) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") @edu.umd.cs.findbugs.annotations.SuppressFBWarnings(value = "DLS\_DEAD\_LOCAL\_STORE", justification = "False positive: bytecode needlessly but harmlessly assigns local to JVM register") protected void nodeCompleted([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node) Determines, when the ANT Task that is represented by the "node" should perform. Node must be an ANT Task or no "perform" is called. If node is an ANT Task, it performs right after complete construction. If node is nested in a TaskContainer, calling "perform" is delegated to that TaskContainer. Parameters: `parent` - note: null when node is root `node` - the node that now has all its children applied ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected void setParent([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child) ### public void setSaveStreams(boolean saveStreams) Indicates that we save stdin, stdout, stderr and replace them while AntBuilder is executing tasks with streams that funnel the normal streams into Ant's logs. Parameters: `saveStreams` - set to false to disable this behavior ### protected void setText([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") task, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text) groovy [Groovy] Class FileNameFinder [Groovy] Class FileNameFinder ============================= * groovy.ant.FileNameFinder All Implemented Interfaces and Traits: [IFileNameFinder](../util/ifilenamefinder "IFileNameFinder") ``` class FileNameFinder extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") implements [IFileNameFinder](../util/ifilenamefinder "IFileNameFinder") ``` Find files according to a base directory and an includes and excludes pattern. The include and exclude patterns conform to Ant's fileset pattern conventions. Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[FileNameFinder](#FileNameFinder())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>` \| `[getFileNames](#getFileNames(java.lang.String,%20java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") basedir, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") pattern)` \| \| \| `[List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>` \| `[getFileNames](#getFileNames(java.lang.String,%20java.lang.String,%20java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") basedir, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") pattern, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") excludesPattern)` \| \| \| `[List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>` \| `[getFileNames](#getFileNames(java.util.Map))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") args)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### FileNameFinder() Method Detail ------------- ### [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> getFileNames([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") basedir, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") pattern) ### [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> getFileNames([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") basedir, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") pattern, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") excludesPattern) ### [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> getFileNames([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") args)	programming_docs
groovy [Groovy] Class RegexChecker.2 [Groovy] Class RegexChecker.2 ============================= * groovy.typecheckers.RegexChecker.2 ``` class RegexChecker.2 extends [CheckingVisitor](../../org/apache/groovy/typecheckers/checkingvisitor) ``` Inherited fields \| Fields inherited from class \| Fields \| \| `class [CheckingVisitor](../../org/apache/groovy/typecheckers/checkingvisitor)` \| `[localConstVars](../../org/apache/groovy/typecheckers/checkingvisitor#localConstVars)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[RegexChecker.2](#RegexChecker.2())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `void` \| `[visitBinaryExpression](#visitBinaryExpression(org.codehaus.groovy.ast.expr.BinaryExpression))([BinaryExpression](../../org/codehaus/groovy/ast/expr/binaryexpression) expression)` \| \| \| `void` \| `[visitDeclarationExpression](#visitDeclarationExpression(org.codehaus.groovy.ast.expr.DeclarationExpression))([DeclarationExpression](../../org/codehaus/groovy/ast/expr/declarationexpression) decl)` \| \| \| `void` \| `[visitMethodCallExpression](#visitMethodCallExpression(org.codehaus.groovy.ast.expr.MethodCallExpression))([MethodCallExpression](../../org/codehaus/groovy/ast/expr/methodcallexpression) call)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [CheckingVisitor](../../org/apache/groovy/typecheckers/checkingvisitor)` \| `[findConstExp](../../org/apache/groovy/typecheckers/checkingvisitor#findConstExp(org.codehaus.groovy.ast.expr.Expression,%20java.lang.Class)), [findTargetVariable](../../org/apache/groovy/typecheckers/checkingvisitor#findTargetVariable(org.codehaus.groovy.ast.expr.VariableExpression)), [getSourceUnit](../../org/apache/groovy/typecheckers/checkingvisitor#getSourceUnit())` \| \| `class [ClassCodeVisitorSupport](../../org/codehaus/groovy/ast/classcodevisitorsupport)` \| `[addError](../../org/codehaus/groovy/ast/classcodevisitorsupport#addError(java.lang.String,%20org.codehaus.groovy.ast.ASTNode)), [getSourceUnit](../../org/codehaus/groovy/ast/classcodevisitorsupport#getSourceUnit()), [visitAnnotation](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitAnnotation(org.codehaus.groovy.ast.AnnotationNode)), [visitAnnotations](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitAnnotations(org.codehaus.groovy.ast.AnnotatedNode)), [visitAnnotations](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitAnnotations(Iterable)), [visitAssertStatement](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitAssertStatement(org.codehaus.groovy.ast.stmt.AssertStatement)), [visitBlockStatement](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitBlockStatement(org.codehaus.groovy.ast.stmt.BlockStatement)), [visitBreakStatement](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitBreakStatement(org.codehaus.groovy.ast.stmt.BreakStatement)), [visitCaseStatement](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitCaseStatement(org.codehaus.groovy.ast.stmt.CaseStatement)), [visitCatchStatement](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitCatchStatement(org.codehaus.groovy.ast.stmt.CatchStatement)), [visitClass](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitClass(org.codehaus.groovy.ast.ClassNode)), [visitClassCodeContainer](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitClassCodeContainer(org.codehaus.groovy.ast.stmt.Statement)), [visitConstructor](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitConstructor(org.codehaus.groovy.ast.ConstructorNode)), [visitConstructorOrMethod](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitConstructorOrMethod(org.codehaus.groovy.ast.MethodNode,%20boolean)), [visitContinueStatement](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitContinueStatement(org.codehaus.groovy.ast.stmt.ContinueStatement)), [visitDeclarationExpression](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitDeclarationExpression(org.codehaus.groovy.ast.expr.DeclarationExpression)), [visitDoWhileLoop](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitDoWhileLoop(org.codehaus.groovy.ast.stmt.DoWhileStatement)), [visitExpressionStatement](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitExpressionStatement(org.codehaus.groovy.ast.stmt.ExpressionStatement)), [visitField](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitField(org.codehaus.groovy.ast.FieldNode)), [visitForLoop](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitForLoop(org.codehaus.groovy.ast.stmt.ForStatement)), [visitIfElse](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitIfElse(org.codehaus.groovy.ast.stmt.IfStatement)), [visitImports](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitImports(org.codehaus.groovy.ast.ModuleNode)), [visitMethod](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitMethod(org.codehaus.groovy.ast.MethodNode)), [visitObjectInitializerStatements](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitObjectInitializerStatements(org.codehaus.groovy.ast.ClassNode)), [visitPackage](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitPackage(org.codehaus.groovy.ast.PackageNode)), [visitProperty](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitProperty(org.codehaus.groovy.ast.PropertyNode)), [visitReturnStatement](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitReturnStatement(org.codehaus.groovy.ast.stmt.ReturnStatement)), [visitStatement](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitStatement(org.codehaus.groovy.ast.stmt.Statement)), [visitSwitch](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitSwitch(org.codehaus.groovy.ast.stmt.SwitchStatement)), [visitSynchronizedStatement](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitSynchronizedStatement(org.codehaus.groovy.ast.stmt.SynchronizedStatement)), [visitThrowStatement](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitThrowStatement(org.codehaus.groovy.ast.stmt.ThrowStatement)), [visitTryCatchFinally](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitTryCatchFinally(org.codehaus.groovy.ast.stmt.TryCatchStatement)), [visitWhileLoop](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitWhileLoop(org.codehaus.groovy.ast.stmt.WhileStatement))` \| \| `class [CodeVisitorSupport](../../org/codehaus/groovy/ast/codevisitorsupport)` \| `[afterSwitchConditionExpressionVisited](../../org/codehaus/groovy/ast/codevisitorsupport#afterSwitchConditionExpressionVisited(org.codehaus.groovy.ast.stmt.SwitchStatement)), [visitArgumentlistExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitArgumentlistExpression(org.codehaus.groovy.ast.expr.ArgumentListExpression)), [visitArrayExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitArrayExpression(org.codehaus.groovy.ast.expr.ArrayExpression)), [visitAssertStatement](../../org/codehaus/groovy/ast/codevisitorsupport#visitAssertStatement(org.codehaus.groovy.ast.stmt.AssertStatement)), [visitAttributeExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitAttributeExpression(org.codehaus.groovy.ast.expr.AttributeExpression)), [visitBinaryExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitBinaryExpression(org.codehaus.groovy.ast.expr.BinaryExpression)), [visitBitwiseNegationExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitBitwiseNegationExpression(org.codehaus.groovy.ast.expr.BitwiseNegationExpression)), [visitBlockStatement](../../org/codehaus/groovy/ast/codevisitorsupport#visitBlockStatement(org.codehaus.groovy.ast.stmt.BlockStatement)), [visitBooleanExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitBooleanExpression(org.codehaus.groovy.ast.expr.BooleanExpression)), [visitBreakStatement](../../org/codehaus/groovy/ast/codevisitorsupport#visitBreakStatement(org.codehaus.groovy.ast.stmt.BreakStatement)), [visitBytecodeExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitBytecodeExpression(org.codehaus.groovy.classgen.BytecodeExpression)), [visitCaseStatement](../../org/codehaus/groovy/ast/codevisitorsupport#visitCaseStatement(org.codehaus.groovy.ast.stmt.CaseStatement)), [visitCastExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitCastExpression(org.codehaus.groovy.ast.expr.CastExpression)), [visitCatchStatement](../../org/codehaus/groovy/ast/codevisitorsupport#visitCatchStatement(org.codehaus.groovy.ast.stmt.CatchStatement)), [visitClassExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitClassExpression(org.codehaus.groovy.ast.expr.ClassExpression)), [visitClosureExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitClosureExpression(org.codehaus.groovy.ast.expr.ClosureExpression)), [visitClosureListExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitClosureListExpression(org.codehaus.groovy.ast.expr.ClosureListExpression)), [visitConstantExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitConstantExpression(org.codehaus.groovy.ast.expr.ConstantExpression)), [visitConstructorCallExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitConstructorCallExpression(org.codehaus.groovy.ast.expr.ConstructorCallExpression)), [visitContinueStatement](../../org/codehaus/groovy/ast/codevisitorsupport#visitContinueStatement(org.codehaus.groovy.ast.stmt.ContinueStatement)), [visitDeclarationExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitDeclarationExpression(org.codehaus.groovy.ast.expr.DeclarationExpression)), [visitDoWhileLoop](../../org/codehaus/groovy/ast/codevisitorsupport#visitDoWhileLoop(org.codehaus.groovy.ast.stmt.DoWhileStatement)), [visitEmptyStatement](../../org/codehaus/groovy/ast/codevisitorsupport#visitEmptyStatement(org.codehaus.groovy.ast.stmt.EmptyStatement)), [visitExpressionStatement](../../org/codehaus/groovy/ast/codevisitorsupport#visitExpressionStatement(org.codehaus.groovy.ast.stmt.ExpressionStatement)), [visitFieldExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitFieldExpression(org.codehaus.groovy.ast.expr.FieldExpression)), [visitForLoop](../../org/codehaus/groovy/ast/codevisitorsupport#visitForLoop(org.codehaus.groovy.ast.stmt.ForStatement)), [visitGStringExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitGStringExpression(org.codehaus.groovy.ast.expr.GStringExpression)), [visitIfElse](../../org/codehaus/groovy/ast/codevisitorsupport#visitIfElse(org.codehaus.groovy.ast.stmt.IfStatement)), [visitLambdaExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitLambdaExpression(org.codehaus.groovy.ast.expr.LambdaExpression)), [visitListExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitListExpression(org.codehaus.groovy.ast.expr.ListExpression)), [visitMapEntryExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitMapEntryExpression(org.codehaus.groovy.ast.expr.MapEntryExpression)), [visitMapExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitMapExpression(org.codehaus.groovy.ast.expr.MapExpression)), [visitMethodCallExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitMethodCallExpression(org.codehaus.groovy.ast.expr.MethodCallExpression)), [visitMethodPointerExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitMethodPointerExpression(org.codehaus.groovy.ast.expr.MethodPointerExpression)), [visitMethodReferenceExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitMethodReferenceExpression(org.codehaus.groovy.ast.expr.MethodReferenceExpression)), [visitNotExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitNotExpression(org.codehaus.groovy.ast.expr.NotExpression)), [visitPostfixExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitPostfixExpression(org.codehaus.groovy.ast.expr.PostfixExpression)), [visitPrefixExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitPrefixExpression(org.codehaus.groovy.ast.expr.PrefixExpression)), [visitPropertyExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitPropertyExpression(org.codehaus.groovy.ast.expr.PropertyExpression)), [visitRangeExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitRangeExpression(org.codehaus.groovy.ast.expr.RangeExpression)), [visitReturnStatement](../../org/codehaus/groovy/ast/codevisitorsupport#visitReturnStatement(org.codehaus.groovy.ast.stmt.ReturnStatement)), [visitShortTernaryExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitShortTernaryExpression(org.codehaus.groovy.ast.expr.ElvisOperatorExpression)), [visitSpreadExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitSpreadExpression(org.codehaus.groovy.ast.expr.SpreadExpression)), [visitSpreadMapExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitSpreadMapExpression(org.codehaus.groovy.ast.expr.SpreadMapExpression)), [visitStaticMethodCallExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitStaticMethodCallExpression(org.codehaus.groovy.ast.expr.StaticMethodCallExpression)), [visitSwitch](../../org/codehaus/groovy/ast/codevisitorsupport#visitSwitch(org.codehaus.groovy.ast.stmt.SwitchStatement)), [visitSynchronizedStatement](../../org/codehaus/groovy/ast/codevisitorsupport#visitSynchronizedStatement(org.codehaus.groovy.ast.stmt.SynchronizedStatement)), [visitTernaryExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitTernaryExpression(org.codehaus.groovy.ast.expr.TernaryExpression)), [visitThrowStatement](../../org/codehaus/groovy/ast/codevisitorsupport#visitThrowStatement(org.codehaus.groovy.ast.stmt.ThrowStatement)), [visitTryCatchFinally](../../org/codehaus/groovy/ast/codevisitorsupport#visitTryCatchFinally(org.codehaus.groovy.ast.stmt.TryCatchStatement)), [visitTupleExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitTupleExpression(org.codehaus.groovy.ast.expr.TupleExpression)), [visitUnaryMinusExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitUnaryMinusExpression(org.codehaus.groovy.ast.expr.UnaryMinusExpression)), [visitUnaryPlusExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitUnaryPlusExpression(org.codehaus.groovy.ast.expr.UnaryPlusExpression)), [visitVariableExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitVariableExpression(org.codehaus.groovy.ast.expr.VariableExpression)), [visitWhileLoop](../../org/codehaus/groovy/ast/codevisitorsupport#visitWhileLoop(org.codehaus.groovy.ast.stmt.WhileStatement))` \| Constructor Detail ------------------ ### RegexChecker.2() Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") void visitBinaryExpression([BinaryExpression](../../org/codehaus/groovy/ast/expr/binaryexpression) expression) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") void visitDeclarationExpression([DeclarationExpression](../../org/codehaus/groovy/ast/expr/declarationexpression) decl) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") void visitMethodCallExpression([MethodCallExpression](../../org/codehaus/groovy/ast/expr/methodcallexpression) call) groovy [Groovy] Class RegexChecker.1 [Groovy] Class RegexChecker.1 ============================= * groovy.typecheckers.RegexChecker.1 ``` class RegexChecker.1 extends [CheckingVisitor](../../org/apache/groovy/typecheckers/checkingvisitor) ``` Inherited fields \| Fields inherited from class \| Fields \| \| `class [CheckingVisitor](../../org/apache/groovy/typecheckers/checkingvisitor)` \| `[localConstVars](../../org/apache/groovy/typecheckers/checkingvisitor#localConstVars)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[RegexChecker.1](#RegexChecker.1())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `void` \| `[visitBinaryExpression](#visitBinaryExpression(org.codehaus.groovy.ast.expr.BinaryExpression))([BinaryExpression](../../org/codehaus/groovy/ast/expr/binaryexpression) expression)` \| \| \| `void` \| `[visitBitwiseNegationExpression](#visitBitwiseNegationExpression(org.codehaus.groovy.ast.expr.BitwiseNegationExpression))([BitwiseNegationExpression](../../org/codehaus/groovy/ast/expr/bitwisenegationexpression) expression)` \| \| \| `void` \| `[visitDeclarationExpression](#visitDeclarationExpression(org.codehaus.groovy.ast.expr.DeclarationExpression))([DeclarationExpression](../../org/codehaus/groovy/ast/expr/declarationexpression) decl)` \| \| \| `void` \| `[visitMethodCallExpression](#visitMethodCallExpression(org.codehaus.groovy.ast.expr.MethodCallExpression))([MethodCallExpression](../../org/codehaus/groovy/ast/expr/methodcallexpression) call)` \| \| \| `void` \| `[visitStaticMethodCallExpression](#visitStaticMethodCallExpression(org.codehaus.groovy.ast.expr.StaticMethodCallExpression))([StaticMethodCallExpression](../../org/codehaus/groovy/ast/expr/staticmethodcallexpression) call)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [CheckingVisitor](../../org/apache/groovy/typecheckers/checkingvisitor)` \| `[findConstExp](../../org/apache/groovy/typecheckers/checkingvisitor#findConstExp(org.codehaus.groovy.ast.expr.Expression,%20java.lang.Class)), [findTargetVariable](../../org/apache/groovy/typecheckers/checkingvisitor#findTargetVariable(org.codehaus.groovy.ast.expr.VariableExpression)), [getSourceUnit](../../org/apache/groovy/typecheckers/checkingvisitor#getSourceUnit())` \| \| `class [ClassCodeVisitorSupport](../../org/codehaus/groovy/ast/classcodevisitorsupport)` \| `[addError](../../org/codehaus/groovy/ast/classcodevisitorsupport#addError(java.lang.String,%20org.codehaus.groovy.ast.ASTNode)), [getSourceUnit](../../org/codehaus/groovy/ast/classcodevisitorsupport#getSourceUnit()), [visitAnnotation](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitAnnotation(org.codehaus.groovy.ast.AnnotationNode)), [visitAnnotations](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitAnnotations(org.codehaus.groovy.ast.AnnotatedNode)), [visitAnnotations](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitAnnotations(Iterable)), [visitAssertStatement](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitAssertStatement(org.codehaus.groovy.ast.stmt.AssertStatement)), [visitBlockStatement](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitBlockStatement(org.codehaus.groovy.ast.stmt.BlockStatement)), [visitBreakStatement](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitBreakStatement(org.codehaus.groovy.ast.stmt.BreakStatement)), [visitCaseStatement](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitCaseStatement(org.codehaus.groovy.ast.stmt.CaseStatement)), [visitCatchStatement](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitCatchStatement(org.codehaus.groovy.ast.stmt.CatchStatement)), [visitClass](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitClass(org.codehaus.groovy.ast.ClassNode)), [visitClassCodeContainer](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitClassCodeContainer(org.codehaus.groovy.ast.stmt.Statement)), [visitConstructor](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitConstructor(org.codehaus.groovy.ast.ConstructorNode)), [visitConstructorOrMethod](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitConstructorOrMethod(org.codehaus.groovy.ast.MethodNode,%20boolean)), [visitContinueStatement](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitContinueStatement(org.codehaus.groovy.ast.stmt.ContinueStatement)), [visitDeclarationExpression](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitDeclarationExpression(org.codehaus.groovy.ast.expr.DeclarationExpression)), [visitDoWhileLoop](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitDoWhileLoop(org.codehaus.groovy.ast.stmt.DoWhileStatement)), [visitExpressionStatement](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitExpressionStatement(org.codehaus.groovy.ast.stmt.ExpressionStatement)), [visitField](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitField(org.codehaus.groovy.ast.FieldNode)), [visitForLoop](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitForLoop(org.codehaus.groovy.ast.stmt.ForStatement)), [visitIfElse](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitIfElse(org.codehaus.groovy.ast.stmt.IfStatement)), [visitImports](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitImports(org.codehaus.groovy.ast.ModuleNode)), [visitMethod](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitMethod(org.codehaus.groovy.ast.MethodNode)), [visitObjectInitializerStatements](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitObjectInitializerStatements(org.codehaus.groovy.ast.ClassNode)), [visitPackage](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitPackage(org.codehaus.groovy.ast.PackageNode)), [visitProperty](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitProperty(org.codehaus.groovy.ast.PropertyNode)), [visitReturnStatement](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitReturnStatement(org.codehaus.groovy.ast.stmt.ReturnStatement)), [visitStatement](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitStatement(org.codehaus.groovy.ast.stmt.Statement)), [visitSwitch](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitSwitch(org.codehaus.groovy.ast.stmt.SwitchStatement)), [visitSynchronizedStatement](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitSynchronizedStatement(org.codehaus.groovy.ast.stmt.SynchronizedStatement)), [visitThrowStatement](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitThrowStatement(org.codehaus.groovy.ast.stmt.ThrowStatement)), [visitTryCatchFinally](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitTryCatchFinally(org.codehaus.groovy.ast.stmt.TryCatchStatement)), [visitWhileLoop](../../org/codehaus/groovy/ast/classcodevisitorsupport#visitWhileLoop(org.codehaus.groovy.ast.stmt.WhileStatement))` \| \| `class [CodeVisitorSupport](../../org/codehaus/groovy/ast/codevisitorsupport)` \| `[afterSwitchConditionExpressionVisited](../../org/codehaus/groovy/ast/codevisitorsupport#afterSwitchConditionExpressionVisited(org.codehaus.groovy.ast.stmt.SwitchStatement)), [visitArgumentlistExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitArgumentlistExpression(org.codehaus.groovy.ast.expr.ArgumentListExpression)), [visitArrayExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitArrayExpression(org.codehaus.groovy.ast.expr.ArrayExpression)), [visitAssertStatement](../../org/codehaus/groovy/ast/codevisitorsupport#visitAssertStatement(org.codehaus.groovy.ast.stmt.AssertStatement)), [visitAttributeExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitAttributeExpression(org.codehaus.groovy.ast.expr.AttributeExpression)), [visitBinaryExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitBinaryExpression(org.codehaus.groovy.ast.expr.BinaryExpression)), [visitBitwiseNegationExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitBitwiseNegationExpression(org.codehaus.groovy.ast.expr.BitwiseNegationExpression)), [visitBlockStatement](../../org/codehaus/groovy/ast/codevisitorsupport#visitBlockStatement(org.codehaus.groovy.ast.stmt.BlockStatement)), [visitBooleanExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitBooleanExpression(org.codehaus.groovy.ast.expr.BooleanExpression)), [visitBreakStatement](../../org/codehaus/groovy/ast/codevisitorsupport#visitBreakStatement(org.codehaus.groovy.ast.stmt.BreakStatement)), [visitBytecodeExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitBytecodeExpression(org.codehaus.groovy.classgen.BytecodeExpression)), [visitCaseStatement](../../org/codehaus/groovy/ast/codevisitorsupport#visitCaseStatement(org.codehaus.groovy.ast.stmt.CaseStatement)), [visitCastExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitCastExpression(org.codehaus.groovy.ast.expr.CastExpression)), [visitCatchStatement](../../org/codehaus/groovy/ast/codevisitorsupport#visitCatchStatement(org.codehaus.groovy.ast.stmt.CatchStatement)), [visitClassExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitClassExpression(org.codehaus.groovy.ast.expr.ClassExpression)), [visitClosureExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitClosureExpression(org.codehaus.groovy.ast.expr.ClosureExpression)), [visitClosureListExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitClosureListExpression(org.codehaus.groovy.ast.expr.ClosureListExpression)), [visitConstantExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitConstantExpression(org.codehaus.groovy.ast.expr.ConstantExpression)), [visitConstructorCallExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitConstructorCallExpression(org.codehaus.groovy.ast.expr.ConstructorCallExpression)), [visitContinueStatement](../../org/codehaus/groovy/ast/codevisitorsupport#visitContinueStatement(org.codehaus.groovy.ast.stmt.ContinueStatement)), [visitDeclarationExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitDeclarationExpression(org.codehaus.groovy.ast.expr.DeclarationExpression)), [visitDoWhileLoop](../../org/codehaus/groovy/ast/codevisitorsupport#visitDoWhileLoop(org.codehaus.groovy.ast.stmt.DoWhileStatement)), [visitEmptyStatement](../../org/codehaus/groovy/ast/codevisitorsupport#visitEmptyStatement(org.codehaus.groovy.ast.stmt.EmptyStatement)), [visitExpressionStatement](../../org/codehaus/groovy/ast/codevisitorsupport#visitExpressionStatement(org.codehaus.groovy.ast.stmt.ExpressionStatement)), [visitFieldExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitFieldExpression(org.codehaus.groovy.ast.expr.FieldExpression)), [visitForLoop](../../org/codehaus/groovy/ast/codevisitorsupport#visitForLoop(org.codehaus.groovy.ast.stmt.ForStatement)), [visitGStringExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitGStringExpression(org.codehaus.groovy.ast.expr.GStringExpression)), [visitIfElse](../../org/codehaus/groovy/ast/codevisitorsupport#visitIfElse(org.codehaus.groovy.ast.stmt.IfStatement)), [visitLambdaExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitLambdaExpression(org.codehaus.groovy.ast.expr.LambdaExpression)), [visitListExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitListExpression(org.codehaus.groovy.ast.expr.ListExpression)), [visitMapEntryExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitMapEntryExpression(org.codehaus.groovy.ast.expr.MapEntryExpression)), [visitMapExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitMapExpression(org.codehaus.groovy.ast.expr.MapExpression)), [visitMethodCallExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitMethodCallExpression(org.codehaus.groovy.ast.expr.MethodCallExpression)), [visitMethodPointerExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitMethodPointerExpression(org.codehaus.groovy.ast.expr.MethodPointerExpression)), [visitMethodReferenceExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitMethodReferenceExpression(org.codehaus.groovy.ast.expr.MethodReferenceExpression)), [visitNotExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitNotExpression(org.codehaus.groovy.ast.expr.NotExpression)), [visitPostfixExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitPostfixExpression(org.codehaus.groovy.ast.expr.PostfixExpression)), [visitPrefixExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitPrefixExpression(org.codehaus.groovy.ast.expr.PrefixExpression)), [visitPropertyExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitPropertyExpression(org.codehaus.groovy.ast.expr.PropertyExpression)), [visitRangeExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitRangeExpression(org.codehaus.groovy.ast.expr.RangeExpression)), [visitReturnStatement](../../org/codehaus/groovy/ast/codevisitorsupport#visitReturnStatement(org.codehaus.groovy.ast.stmt.ReturnStatement)), [visitShortTernaryExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitShortTernaryExpression(org.codehaus.groovy.ast.expr.ElvisOperatorExpression)), [visitSpreadExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitSpreadExpression(org.codehaus.groovy.ast.expr.SpreadExpression)), [visitSpreadMapExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitSpreadMapExpression(org.codehaus.groovy.ast.expr.SpreadMapExpression)), [visitStaticMethodCallExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitStaticMethodCallExpression(org.codehaus.groovy.ast.expr.StaticMethodCallExpression)), [visitSwitch](../../org/codehaus/groovy/ast/codevisitorsupport#visitSwitch(org.codehaus.groovy.ast.stmt.SwitchStatement)), [visitSynchronizedStatement](../../org/codehaus/groovy/ast/codevisitorsupport#visitSynchronizedStatement(org.codehaus.groovy.ast.stmt.SynchronizedStatement)), [visitTernaryExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitTernaryExpression(org.codehaus.groovy.ast.expr.TernaryExpression)), [visitThrowStatement](../../org/codehaus/groovy/ast/codevisitorsupport#visitThrowStatement(org.codehaus.groovy.ast.stmt.ThrowStatement)), [visitTryCatchFinally](../../org/codehaus/groovy/ast/codevisitorsupport#visitTryCatchFinally(org.codehaus.groovy.ast.stmt.TryCatchStatement)), [visitTupleExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitTupleExpression(org.codehaus.groovy.ast.expr.TupleExpression)), [visitUnaryMinusExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitUnaryMinusExpression(org.codehaus.groovy.ast.expr.UnaryMinusExpression)), [visitUnaryPlusExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitUnaryPlusExpression(org.codehaus.groovy.ast.expr.UnaryPlusExpression)), [visitVariableExpression](../../org/codehaus/groovy/ast/codevisitorsupport#visitVariableExpression(org.codehaus.groovy.ast.expr.VariableExpression)), [visitWhileLoop](../../org/codehaus/groovy/ast/codevisitorsupport#visitWhileLoop(org.codehaus.groovy.ast.stmt.WhileStatement))` \| Constructor Detail ------------------ ### RegexChecker.1() Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") void visitBinaryExpression([BinaryExpression](../../org/codehaus/groovy/ast/expr/binaryexpression) expression) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") void visitBitwiseNegationExpression([BitwiseNegationExpression](../../org/codehaus/groovy/ast/expr/bitwisenegationexpression) expression) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") void visitDeclarationExpression([DeclarationExpression](../../org/codehaus/groovy/ast/expr/declarationexpression) decl) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") void visitMethodCallExpression([MethodCallExpression](../../org/codehaus/groovy/ast/expr/methodcallexpression) call) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") void visitStaticMethodCallExpression([StaticMethodCallExpression](../../org/codehaus/groovy/ast/expr/staticmethodcallexpression) call)	programming_docs
groovy [Groovy] Class RegexChecker [Groovy] Class RegexChecker =========================== * groovy.typecheckers.RegexChecker ``` @[Incubating](../../org/apache/groovy/lang/annotation/incubating "Incubating") class RegexChecker extends [TypeCheckingDSL](../../org/codehaus/groovy/transform/stc/groovytypecheckingextensionsupport.typecheckingdsl) ``` Checks at compile-time for cases of invalid regex usage where the actual regex string can be identified (e.g. inline or defined by a local variable with an initial value or a field with an initial value). A number of errors which would normally surface only at runtime are handled. * Invalid pattern definitions when using the Groovy pattern operator or the JDK's `Pattern#compile` method: ``` ~/\w{3/ // missing closing repetition quantifier brace ~"(.)o(." // missing closing group bracket Pattern.compile(/?/) // dangling meta character '?' (Java longhand) ``` These examples illustrate explicitly defined constant strings but local variable or field definitions where a constant string can be determined are also checked. Invalid regex strings in conjunction with Groovy's regex find and regex match expressions, or the JDK's `Pattern#matches` method: ``` 'foobar' =~ /f[o]{2/ // missing closing repetition quantifier brace 'foobar' ==~ /(foo/ // missing closing group bracket Pattern.matches(/?/, 'foo') // dangling meta character '?' (Java longhand) ``` Invalid group count terms where the regex string can be determined and the group index can be determined to be a constant. * ``` def m = 'foobar' =~ /(...)(...)/ assert m[0][1] == 'foo' // okay assert m[0][3] // type error: only two groups in regex ``` And similarly for Java long-hand variants: ``` Pattern p = Pattern.compile('(...)(...)') Matcher m = p.matcher('foobar') assert m.find() assert m.group(1) == 'foo' // okay assert m.group(3) // type error: only two groups in regex ``` Also, when using the regex find operator, smarter type inferencing occurs. For an expression like `matcher[0]`, the `getAt` extension method for `Matcher` is called. This may return a String (if no groups occur within the regex) or a list of String values if grouping is used, hence the declared return type of the mentioned `getAt` method is `Object` to account for these two possibilities. When using `RegexChecker`, the inferred type will be either `String` or `List<String>` when a regex string can be identified. Over time, the idea would be to support more cases as per: https://checkerframework.org/manual/#regex-checker https://homes.cs.washington.edu/~mernst/pubs/regex-types-ftfjp2012.pdf https://github.com/typetools/checker-framework/tree/master/checker/src/main/java/org/checkerframework/checker/regex Nested Class Summary -------------------- Nested classes \| Modifiers \| Name \| Description \| \| `class` \| `[RegexChecker.1](regexchecker.1)` \| \| \| `class` \| `[RegexChecker.2](regexchecker.2)` \| \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[RegexChecker](#RegexChecker())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[run](#run())()` \| Constructor Detail ------------------ ### RegexChecker() Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") run() groovy [Java] Class GroovyMain [Java] Class GroovyMain ======================= * groovy.ui.GroovyMain ``` public class GroovyMain extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` A Command line to execute groovy. Nested Class Summary -------------------- Nested classes \| Modifiers \| Name \| Description \| \| `static class` \| `[GroovyMain.VersionProvider](groovymain.versionprovider)` \| \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[buildConfigScriptText](#buildConfigScriptText(List))([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> transforms)` \| \| \| `protected [GroovyCodeSource](../lang/groovycodesource)` \| `[getScriptSource](#getScriptSource(boolean,%20java.lang.String))(boolean isScriptFile, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") script)`Get a new GroovyCodeSource for a script which may be given as a location (isScript is true) or as text (isScript is false). \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getText](#getText(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uriOrFilename)`Get the text of the Groovy script at the given location. \| \| \| `public [File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File")` \| `[huntForTheScriptFile](#huntForTheScriptFile(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") input)`Hunt for the script file by calling searchForGroovyScriptFile(String). \| \| \| `public static void` \| `[main](#main(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")[] args)`Main CLI interface. \| \| \| `public static void` \| `[processConfigScriptText](#processConfigScriptText(java.lang.String,%20org.codehaus.groovy.control.CompilerConfiguration))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") scriptText, [CompilerConfiguration](../../org/codehaus/groovy/control/compilerconfiguration) conf)` \| \| \| `public static void` \| `[processConfigScripts](#processConfigScripts(List,%20org.codehaus.groovy.control.CompilerConfiguration))([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> scripts, [CompilerConfiguration](../../org/codehaus/groovy/control/compilerconfiguration) conf)` \| \| \| `public static [File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File")` \| `[searchForGroovyScriptFile](#searchForGroovyScriptFile(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") input)`Search for the script file, doesn't bother if it is named precisely. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") buildConfigScriptText([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> transforms) ### protected [GroovyCodeSource](../lang/groovycodesource) getScriptSource(boolean isScriptFile, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") script) Get a new GroovyCodeSource for a script which may be given as a location (isScript is true) or as text (isScript is false). throws: IOException throws: URISyntaxException Parameters: `isScriptFile` - indicates whether the script parameter is a location or content `script` - the location or context of the script Returns: a new GroovyCodeSource for the given script Since: 2.3.0 ### @[Deprecated](https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html "Deprecated") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getText([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uriOrFilename) Get the text of the Groovy script at the given location. If the location is a file path and it does not exist as given, then [GroovyMain.huntForTheScriptFile](groovymain#huntForTheScriptFile(java.lang.String) "GroovyMain.huntForTheScriptFile") is called to try with some Groovy extensions appended. This method is not used to process scripts and is retained for backward compatibility. If you want to modify how GroovyMain processes scripts then use [GroovyMain.getScriptSource](groovymain#getScriptSource(boolean,%20java.lang.String) "GroovyMain.getScriptSource"). throws: IOException deprecated: Parameters: uriOrFilename Returns: the text content at the location ### public [File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File") huntForTheScriptFile([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") input) Hunt for the script file by calling searchForGroovyScriptFile(String). See Also: [GroovyMain.searchForGroovyScriptFile](groovymain#searchForGroovyScriptFile(java.lang.String) "GroovyMain.searchForGroovyScriptFile") ### public static void main([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")[] args) Main CLI interface. Parameters: `args` - all command line args. ### public static void processConfigScriptText([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") scriptText, [CompilerConfiguration](../../org/codehaus/groovy/control/compilerconfiguration) conf) ### public static void processConfigScripts([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> scripts, [CompilerConfiguration](../../org/codehaus/groovy/control/compilerconfiguration) conf) ### public static [File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File") searchForGroovyScriptFile([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") input) Search for the script file, doesn't bother if it is named precisely. Tries in this order: - actual supplied name - name.groovy - name.gvy - name.gy - name.gsh Since: 2.3.0 groovy [Java] Class GroovySocketServer [Java] Class GroovySocketServer =============================== * groovy.ui.GroovySocketServer All Implemented Interfaces and Traits: [Runnable](https://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html "Runnable") ``` public class GroovySocketServer extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") implements [Runnable](https://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html "Runnable") ``` Simple server that executes supplied script against a socket. Typically this is used from the groovy command line agent but it can be invoked programmatically. To run this program from the command line please refer to the command line documentation at [Running Groovy from the commandline](http://docs.groovy-lang.org/docs/latest/html/documentation/#_running_groovy_from_the_commandline). Here is an example of how to use this class to open a listening socket on the server, listen for incoming data, and then echo the data back to the client in reverse order: ``` new GroovySocketServer( new GroovyShell(), // evaluator false, // is not a file "println line.reverse()", // script to evaluate true, // return result to client 1960) //port ``` There are several variables in the script binding: * line - The data from the socket * out - The output PrintWriter, should you need it for some reason. * socket - The socket, should you need it for some reason. Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[GroovySocketServer](#GroovySocketServer(groovy.lang.GroovyShell,%20boolean,%20java.lang.String,%20boolean,%20int))([GroovyShell](../lang/groovyshell) groovy, boolean isScriptFile, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") scriptFilenameOrText, boolean autoOutput, int port)`This creates and starts the socket server on a new Thread. \| \| `[GroovySocketServer](#GroovySocketServer(groovy.lang.GroovyShell,%20groovy.lang.GroovyCodeSource,%20boolean,%20int))([GroovyShell](../lang/groovyshell) groovy, [GroovyCodeSource](../lang/groovycodesource) source, boolean autoOutput, int port)`This creates and starts the socket server on a new Thread. \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public void` \| `[run](#run())()`Runs this server. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public GroovySocketServer([GroovyShell](../lang/groovyshell) groovy, boolean isScriptFile, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") scriptFilenameOrText, boolean autoOutput, int port) This creates and starts the socket server on a new Thread. There is no need to call run or spawn a new thread yourself. Parameters: `groovy` - The GroovyShell object that evaluates the incoming text. If you need additional classes in the classloader then configure that through this object. `isScriptFile` - Whether the incoming socket data String will be a script or a file path. `scriptFilenameOrText` - This will be a groovy script or a file location depending on the argument isScriptFile. `autoOutput` - whether output should be automatically echoed back to the client `port` - the port to listen on ### public GroovySocketServer([GroovyShell](../lang/groovyshell) groovy, [GroovyCodeSource](../lang/groovycodesource) source, boolean autoOutput, int port) This creates and starts the socket server on a new Thread. There is no need to call run or spawn a new thread yourself. Parameters: `groovy` - The GroovyShell object that evaluates the incoming text. If you need additional classes in the classloader then configure that through this object. `source` - GroovyCodeSource for the Groovy script `autoOutput` - whether output should be automatically echoed back to the client `port` - the port to listen on Since: 2.3.0 Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void run() Runs this server. There is typically no need to call this method, as the object's constructor creates a new thread and runs this object automatically. groovy [Java] Class GroovyMain.VersionProvider [Java] Class GroovyMain.VersionProvider ======================================= * groovy.ui.GroovyMain.VersionProvider All Implemented Interfaces and Traits: [CommandLine.IVersionProvider](https://picocli.info/apidocs/picocli/CommandLine.IVersionProvider.html "CommandLine.IVersionProvider") ``` public static class GroovyMain.VersionProvider ``` Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")[]` \| `[getVersion](#getVersion())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")[] getVersion() groovy [Java] Class TomlSlurper [Java] Class TomlSlurper ======================== * groovy.toml.TomlSlurper ``` @[Incubating](../../org/apache/groovy/lang/annotation/incubating "Incubating") public class TomlSlurper extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Represents a TOML parser Since: 4.0.0 Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[TomlSlurper](#TomlSlurper())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[parse](#parse(java.io.Reader))([Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") reader)`Parse the content of the specified reader into a tree of Nodes. \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[parse](#parse(java.io.InputStream))([InputStream](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html "InputStream") stream)`Parse the content of the specified reader into a tree of Nodes. \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[parse](#parse(java.io.File))([File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File") file)`Parse the content of the specified file into a tree of Nodes. \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[parse](#parse(java.nio.file.Path))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") path)`Parse the content of the specified path into a tree of Nodes. \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[parseText](#parseText(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") toml)`Parse the content of the specified toml into a tree of Nodes. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public TomlSlurper() Method Detail ------------- ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parse([Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") reader) Parse the content of the specified reader into a tree of Nodes. Parameters: `reader` - the reader of toml Returns: the root node of the parsed tree of Nodes ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parse([InputStream](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html "InputStream") stream) Parse the content of the specified reader into a tree of Nodes. Parameters: `stream` - the reader of toml Returns: the root node of the parsed tree of Nodes ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parse([File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File") file) Parse the content of the specified file into a tree of Nodes. Parameters: `file` - the reader of toml Returns: the root node of the parsed tree of Nodes ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parse([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") path) Parse the content of the specified path into a tree of Nodes. Parameters: `path` - the reader of toml Returns: the root node of the parsed tree of Nodes ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parseText([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") toml) Parse the content of the specified toml into a tree of Nodes. Parameters: `toml` - the content of toml Returns: the root node of the parsed tree of Nodes	programming_docs
groovy [Java] Class TomlRuntimeException [Java] Class TomlRuntimeException ================================= * groovy.toml.TomlRuntimeException ``` @[Incubating](../../org/apache/groovy/lang/annotation/incubating "Incubating") public class TomlRuntimeException extends [GroovyRuntimeException](../lang/groovyruntimeexception) ``` Represents runtime exception occurred when parsing or building TOML Since: 4.0.0 Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[TomlRuntimeException](#TomlRuntimeException(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") msg)` \| \| `[TomlRuntimeException](#TomlRuntimeException(java.lang.Throwable))([Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html "Throwable") cause)` \| \| `[TomlRuntimeException](#TomlRuntimeException(java.lang.String,%20java.lang.Throwable))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") msg, [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html "Throwable") cause)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [GroovyRuntimeException](../lang/groovyruntimeexception)` \| `[getLocationText](../lang/groovyruntimeexception#getLocationText()), [getMessage](../lang/groovyruntimeexception#getMessage()), [getMessageWithoutLocationText](../lang/groovyruntimeexception#getMessageWithoutLocationText()), [getModule](../lang/groovyruntimeexception#getModule()), [getNode](../lang/groovyruntimeexception#getNode()), [setModule](../lang/groovyruntimeexception#setModule(org.codehaus.groovy.ast.ModuleNode))` \| Constructor Detail ------------------ ### public TomlRuntimeException([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") msg) ### public TomlRuntimeException([Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html "Throwable") cause) ### public TomlRuntimeException([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") msg, [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html "Throwable") cause) groovy [Java] Class TomlBuilder [Java] Class TomlBuilder ======================== * groovy.toml.TomlBuilder All Implemented Interfaces and Traits: [Writable](../lang/writable) ``` @[Incubating](../../org/apache/groovy/lang/annotation/incubating "Incubating") public class TomlBuilder extends [GroovyObjectSupport](../lang/groovyobjectsupport) implements [Writable](../lang/writable) ``` A builder for creating TOML payloads. Since: 4.0.0 Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[TomlBuilder](#TomlBuilder())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[call](#call(java.util.Map))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") m)`Named arguments can be passed to the TOML builder instance to create a root TOML object \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[call](#call(java.util.List))([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") l)`A list of elements as arguments to the TOML builder creates a root TOML array \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[call](#call(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args)`Varargs elements as arguments to the TOML builder create a root TOML array \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[call](#call(java.lang.Iterable,%20groovy.lang.Closure))([Iterable](https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html "Iterable") coll, [Closure](../lang/closure) c)`A collection and closure passed to a TOML builder will create a root TOML array applying the closure to each object in the collection \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[call](#call(java.util.Collection,%20groovy.lang.Closure))([Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection") coll, [Closure](../lang/closure) c)`Delegates to [call(Iterable, Closure)](#call(java.lang.Iterable,%20groovy.lang.Closure)) \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[call](#call(groovy.lang.Closure))([Closure](../lang/closure) c)`A closure passed to a TOML builder will create a root TOML object \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getContent](#getContent())()` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[invokeMethod](#invokeMethod(java.lang.String,%20java.lang.Object))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args)`A method call on the TOML builder instance will create a root object with only one key whose name is the name of the method being called. \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[toString](#toString())()`Serializes the internal data structure built with the builder to a conformant TOML payload string \| \| \| `public [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer")` \| `[writeTo](#writeTo(java.io.Writer))([Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") out)`The TOML builder implements the `Writable` interface, so that you can have the builder serialize itself the TOML payload to a writer. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [GroovyObjectSupport](../lang/groovyobjectsupport)` \| `[getMetaClass](../lang/groovyobjectsupport#getMetaClass()), [setMetaClass](../lang/groovyobjectsupport#setMetaClass(groovy.lang.MetaClass))` \| Constructor Detail ------------------ ### public TomlBuilder() Method Detail ------------- ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") call([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") m) Named arguments can be passed to the TOML builder instance to create a root TOML object Example: ``` def toml = new groovy.toml.TomlBuilder() toml name: "Guillaume", age: 33 assert toml.toString() == '''\ name = 'Guillaume' age = 33 ''' ``` Parameters: `m` - a map of key / value pairs Returns: a map of key / value pairs ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") call([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") l) A list of elements as arguments to the TOML builder creates a root TOML array Example: ``` def toml = new groovy.toml.TomlBuilder() def result = toml([1, 2, 3]) assert result instanceof List assert toml.toString() == '''\ = [1, 2, 3] ''' ``` Parameters: `l` - a list of values Returns: a list of values ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") call([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args) Varargs elements as arguments to the TOML builder create a root TOML array Example: ``` def toml = new groovy.toml.TomlBuilder() def result = toml 1, 2, 3 assert result instanceof List assert toml.toString() == '''\ = [1, 2, 3] ''' ``` Parameters: `args` - an array of values Returns: a list of values ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") call([Iterable](https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html "Iterable") coll, [Closure](../lang/closure) c) A collection and closure passed to a TOML builder will create a root TOML array applying the closure to each object in the collection Example: ``` class Author { String name } def authors = [new Author (name: "Guillaume"), new Author (name: "Jochen"), new Author (name: "Paul")] def toml = new groovy.toml.TomlBuilder() toml authors, { Author author `->` name author.name } assert toml.toString() == '''\ = [{name = 'Guillaume'}, {name = 'Jochen'}, {name = 'Paul'}] ''' ``` Parameters: `coll` - a collection `c` - a closure used to convert the objects of coll Returns: a list of values ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") call([Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection") coll, [Closure](../lang/closure) c) Delegates to [call(Iterable, Closure)](#call(java.lang.Iterable,%20groovy.lang.Closure)) Parameters: coll c ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") call([Closure](../lang/closure) c) A closure passed to a TOML builder will create a root TOML object Example: ``` def toml = new groovy.toml.TomlBuilder() def result = toml { name "Guillaume" age 33 } assert result instanceof Map assert toml.toString() == '''\ name = 'Guillaume' age = 33 ''' ``` Parameters: `c` - a closure whose method call statements represent key / values of a TOML object Returns: a map of key / value pairs ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getContent() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") invokeMethod([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args) A method call on the TOML builder instance will create a root object with only one key whose name is the name of the method being called. This method takes as arguments: * a closure * a map (ie. named arguments) * a map and a closure * or no argument at all Example with a classical builder-style: ``` def toml = new groovy.toml.TomlBuilder() def result = toml.person { name "Guillaume" age 33 } assert result instanceof Map assert toml.toString() == '''\ person.name = 'Guillaume' person.age = 33 ''' ``` Or alternatively with a method call taking named arguments: ``` def toml = new groovy.toml.TomlBuilder() toml.person name: "Guillaume", age: 33 assert toml.toString() == '''\ person.name = 'Guillaume' person.age = 33 ''' ``` If you use named arguments and a closure as last argument, the key/value pairs of the map (as named arguments) and the key/value pairs represented in the closure will be merged together — the closure properties overriding the map key/values in case the same key is used. ``` def toml = new groovy.toml.TomlBuilder() toml.person(name: "Guillaume", age: 33) { town "Paris" } assert toml.toString() == '''\ person.name = 'Guillaume' person.age = 33 person.town = 'Paris' ''' ``` The empty args call will create a key whose value will be an empty YAML object: ``` def toml = new groovy.toml.TomlBuilder() toml.person() assert toml.toString() == '''\ person = {} ''' ``` Parameters: `name` - the single key `args` - the value associated with the key Returns: a map with a single key ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") toString() Serializes the internal data structure built with the builder to a conformant TOML payload string Example: ``` def toml = new groovy.toml.TomlBuilder() toml { temperature 37 } assert toml.toString() == '''\ temperature = 37 ''' ``` Returns: a TOML output ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") writeTo([Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") out) The TOML builder implements the `Writable` interface, so that you can have the builder serialize itself the TOML payload to a writer. Example: ``` def toml = new groovy.toml.TomlBuilder() toml { temperature 37 } def out = new StringWriter() out `<<` toml assert out.toString() == '''\ temperature = 37 ''' ``` Parameters: `out` - a writer on which to serialize the TOML payload Returns: the writer groovy [Java] Class GroovyServlet [Java] Class GroovyServlet ========================== * groovy.servlet.GroovyServlet ``` public class GroovyServlet extends [AbstractHttpServlet](abstracthttpservlet) ``` This servlet will run Groovy scripts as Groovlets. Groovlets are scripts with these objects implicit in their scope: * request - the HttpServletRequest * response - the HttpServletResponse * application - the ServletContext associated with the servlet * session - the HttpSession associated with the HttpServletRequest * out - the PrintWriter associated with the ServletRequest Your script sources can be placed either in your web application's normal web root (allows for subdirectories) or in /WEB-INF/groovy/\* (also allows subdirectories). To make your web application more groovy, you must add the GroovyServlet to your application's web.xml configuration using any mapping you like, so long as it follows the pattern \.\ (more on this below). Here is the web.xml entry: ``` <servlet> <servlet-name>Groovy</servlet-name> <servlet-class>groovy.servlet.GroovyServlet</servlet-class> </servlet> <servlet-mapping> <servlet-name>Groovy</servlet-name> <url-pattern>.groovy</url-pattern> <url-pattern>.gdo</url-pattern> </servlet-mapping> ``` The URL pattern does not require the "\.groovy" mapping. You can, for example, make it more Struts-like but groovy by making your mapping "\.gdo". See Also: [ServletBinding](servletbinding "ServletBinding") Inherited fields \| Fields inherited from class \| Fields \| \| `class [AbstractHttpServlet](abstracthttpservlet)` \| `[CONTENT\_TYPE\_TEXT\_HTML](abstracthttpservlet#CONTENT_TYPE_TEXT_HTML), [INC\_PATH\_INFO](abstracthttpservlet#INC_PATH_INFO), [INC\_REQUEST\_URI](abstracthttpservlet#INC_REQUEST_URI), [INC\_SERVLET\_PATH](abstracthttpservlet#INC_SERVLET_PATH), [INIT\_PARAM\_RESOURCE\_NAME\_REGEX](abstracthttpservlet#INIT_PARAM_RESOURCE_NAME_REGEX), [INIT\_PARAM\_RESOURCE\_NAME\_REGEX\_FLAGS](abstracthttpservlet#INIT_PARAM_RESOURCE_NAME_REGEX_FLAGS), [encoding](abstracthttpservlet#encoding), [namePrefix](abstracthttpservlet#namePrefix), [reflection](abstracthttpservlet#reflection), [resourceNamePattern](abstracthttpservlet#resourceNamePattern), [resourceNameReplaceAll](abstracthttpservlet#resourceNameReplaceAll), [resourceNameReplacement](abstracthttpservlet#resourceNameReplacement), [servletContext](abstracthttpservlet#servletContext), [verbose](abstracthttpservlet#verbose)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[call](#call())()` \| \| \| `protected [GroovyScriptEngine](../util/groovyscriptengine)` \| `[createGroovyScriptEngine](#createGroovyScriptEngine())()`Hook method to setup the GroovyScriptEngine to use. \| \| \| `public void` \| `[init](#init(javax.servlet.ServletConfig))([ServletConfig](https://docs.oracle.com/javaee/7/api/javax/servlet/ServletConfig.html "ServletConfig") config)`Initialize the GroovyServlet. \| \| \| `public void` \| `[service](#service(javax.servlet.http.HttpServletRequest,%20javax.servlet.http.HttpServletResponse))([HttpServletRequest](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServletRequest.html "HttpServletRequest") request, [HttpServletResponse](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServletResponse.html "HttpServletResponse") response)`Handle web requests to the GroovyServlet \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractHttpServlet](abstracthttpservlet)` \| `[applyResourceNameMatcher](abstracthttpservlet#applyResourceNameMatcher(java.lang.String)), [generateNamePrefixOnce](abstracthttpservlet#generateNamePrefixOnce()), [getResourceConnection](abstracthttpservlet#getResourceConnection(java.lang.String)), [getScriptUri](abstracthttpservlet#getScriptUri(javax.servlet.http.HttpServletRequest)), [getScriptUriAsFile](abstracthttpservlet#getScriptUriAsFile(javax.servlet.http.HttpServletRequest)), [init](abstracthttpservlet#init(javax.servlet.ServletConfig)), [removeNamePrefix](abstracthttpservlet#removeNamePrefix(java.lang.String)), [setVariables](abstracthttpservlet#setVariables(groovy.servlet.ServletBinding))` \| Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") call() ### protected [GroovyScriptEngine](../util/groovyscriptengine) createGroovyScriptEngine() Hook method to setup the GroovyScriptEngine to use. Subclasses may override this method to provide a custom engine. ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void init([ServletConfig](https://docs.oracle.com/javaee/7/api/javax/servlet/ServletConfig.html "ServletConfig") config) Initialize the GroovyServlet. throws: ServletException if this method encountered difficulties ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void service([HttpServletRequest](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServletRequest.html "HttpServletRequest") request, [HttpServletResponse](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServletResponse.html "HttpServletResponse") response) Handle web requests to the GroovyServlet groovy [Java] Class AbstractHttpServlet [Java] Class AbstractHttpServlet ================================ * groovy.servlet.AbstractHttpServlet All Implemented Interfaces and Traits: [ResourceConnector](../util/resourceconnector) ``` public abstract class AbstractHttpServlet extends [HttpServlet](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServlet.html "HttpServlet") implements [ResourceConnector](../util/resourceconnector) ``` A base class dealing with common HTTP servlet API housekeeping aspects. ### Resource name mangling (pattern replacement) Also implements Groovy's [ResourceConnector](../util/resourceconnector "ResourceConnector") in a dynamic manner. It allows you to modify the resource name that is searched for with a replace all operation. See [Pattern](https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html "Pattern") and [Matcher](https://docs.oracle.com/javase/8/docs/api/java/util/regex/Matcher.html "Matcher") for details. The servlet init parameter names are: ``` { ``` value: #INIT\_PARAM\_RESOURCE\_NAME\_REGEX} = empty - defaults to null resource.name.replacement = empty - defaults to null resource.name.replace.all = true (default) \| false means replaceFirst() Note: If you specify a regex, you have to specify a replacement string too! Otherwise an exception gets raised. ### Logging and bug-hunting options This implementation provides a verbosity flag switching log statements. The servlet init parameter name is: ``` verbose = false(default) \| true ``` In order to support class-loading-troubles-debugging with Tomcat 4 or higher, you can log the class loader responsible for loading some classes. See [GROOVY-861](https://issues.apache.org/jira/browse/GROOVY-861) for details. The servlet init parameter name is: ``` log.GROOVY861 = false(default) \| true ``` If you experience class-loading-troubles with Tomcat 4 (or higher) or any other servlet container using custom class loader setups, you can fallback to use (slower) reflection in Groovy's MetaClass implementation. Please contact the dev team with your problem! Thanks. The servlet init parameter name is: ``` reflection = false(default) \| true ``` Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[CONTENT\_TYPE\_TEXT\_HTML](#CONTENT_TYPE_TEXT_HTML)` \| Content type of the HTTP response. \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[INC\_PATH\_INFO](#INC_PATH_INFO)` \| Servlet API include key name: path\_info \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[INC\_REQUEST\_URI](#INC_REQUEST_URI)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[INC\_SERVLET\_PATH](#INC_SERVLET_PATH)` \| Servlet API include key name: servlet\_path \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[INIT\_PARAM\_RESOURCE\_NAME\_REGEX](#INIT_PARAM_RESOURCE_NAME_REGEX)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[INIT\_PARAM\_RESOURCE\_NAME\_REGEX\_FLAGS](#INIT_PARAM_RESOURCE_NAME_REGEX_FLAGS)` \| \| \| `protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[encoding](#encoding)` \| Encoding to use, becomes charset part of contentType. \| \| `protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[namePrefix](#namePrefix)` \| a.fink: it was in [removeNamePrefix](#removeNamePrefix), but was extracted to var for optimization \| \| `protected boolean` \| `[reflection](#reflection)` \| Mirrors the static value of the reflection flag in MetaClass. \| \| `protected [Pattern](https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html "Pattern")` \| `[resourceNamePattern](#resourceNamePattern)` \| Either `null` or a compiled pattern read from "{ value: #INIT\_PARAM\_RESOURCE\_NAME\_REGEX}" and used in [AbstractHttpServlet.getScriptUri](abstracthttpservlet#getScriptUri(javax.servlet.http.HttpServletRequest) "AbstractHttpServlet.getScriptUri"). \| \| `protected boolean` \| `[resourceNameReplaceAll](#resourceNameReplaceAll)` \| The replace method to use on the matcher. \| \| `protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[resourceNameReplacement](#resourceNameReplacement)` \| The replacement used by the resource name matcher. \| \| `protected [ServletContext](https://docs.oracle.com/javaee/7/api/javax/servlet/ServletContext.html "ServletContext")` \| `[servletContext](#servletContext)` \| Servlet (or the web application) context. \| \| `protected boolean` \| `[verbose](#verbose)` \| Controls almost all log output. \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[AbstractHttpServlet](#AbstractHttpServlet())()`Initializes all fields with default values. \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[applyResourceNameMatcher](#applyResourceNameMatcher(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri)` \| \| \| `protected void` \| `[generateNamePrefixOnce](#generateNamePrefixOnce())()` \| \| \| `public [URLConnection](https://docs.oracle.com/javase/8/docs/api/java/net/URLConnection.html "URLConnection")` \| `[getResourceConnection](#getResourceConnection(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name)`Interface method for ResourceContainer. \| \| \| `protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getScriptUri](#getScriptUri(javax.servlet.http.HttpServletRequest))([HttpServletRequest](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServletRequest.html "HttpServletRequest") request)`Returns the include-aware uri of the script or template file. \| \| \| `protected [File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File")` \| `[getScriptUriAsFile](#getScriptUriAsFile(javax.servlet.http.HttpServletRequest))([HttpServletRequest](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServletRequest.html "HttpServletRequest") request)`Parses the http request for the real script or template source file. \| \| \| `public void` \| `[init](#init(javax.servlet.ServletConfig))([ServletConfig](https://docs.oracle.com/javaee/7/api/javax/servlet/ServletConfig.html "ServletConfig") config)`Overrides the generic init method to set some debug flags. \| \| \| `protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[removeNamePrefix](#removeNamePrefix(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name)` \| \| \| `protected void` \| `[setVariables](#setVariables(groovy.servlet.ServletBinding))([ServletBinding](servletbinding) binding)`Override this method to set your variables to the Groovy binding. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [HttpServlet](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServlet.html "HttpServlet")` \| `[service](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServlet.html#service(javax.servlet.ServletRequest,%20javax.servlet.ServletResponse) "service"), [log](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServlet.html#log(java.lang.String,%20java.lang.Throwable) "log"), [log](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServlet.html#log(java.lang.String) "log"), [init](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServlet.html#init(javax.servlet.ServletConfig) "init"), [init](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServlet.html#init() "init"), [destroy](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServlet.html#destroy() "destroy"), [getServletInfo](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServlet.html#getServletInfo() "getServletInfo"), [getServletConfig](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServlet.html#getServletConfig() "getServletConfig"), [getInitParameterNames](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServlet.html#getInitParameterNames() "getInitParameterNames"), [getServletContext](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServlet.html#getServletContext() "getServletContext"), [getServletName](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServlet.html#getServletName() "getServletName"), [getInitParameter](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServlet.html#getInitParameter(java.lang.String) "getInitParameter"), [wait](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServlet.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServlet.html#wait() "wait"), [wait](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServlet.html#wait(long) "wait"), [equals](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServlet.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServlet.html#toString() "toString"), [hashCode](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServlet.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServlet.html#getClass() "getClass"), [notify](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServlet.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServlet.html#notifyAll() "notifyAll")` \| Field Detail ------------ ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") CONTENT\_TYPE\_TEXT\_HTML Content type of the HTTP response. ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") INC\_PATH\_INFO Servlet API include key name: path\_info ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") INC\_REQUEST\_URI ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") INC\_SERVLET\_PATH Servlet API include key name: servlet\_path ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") INIT\_PARAM\_RESOURCE\_NAME\_REGEX ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") INIT\_PARAM\_RESOURCE\_NAME\_REGEX\_FLAGS ### protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") encoding Encoding to use, becomes charset part of contentType. ### protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") namePrefix a.fink: it was in [removeNamePrefix](#removeNamePrefix), but was extracted to var for optimization ### protected boolean reflection Mirrors the static value of the reflection flag in MetaClass. See AbstractHttpServlet#logGROOVY861 ### protected [Pattern](https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html "Pattern") resourceNamePattern Either `null` or a compiled pattern read from "{ value: #INIT\_PARAM\_RESOURCE\_NAME\_REGEX}" and used in [AbstractHttpServlet.getScriptUri](abstracthttpservlet#getScriptUri(javax.servlet.http.HttpServletRequest) "AbstractHttpServlet.getScriptUri"). ### protected boolean resourceNameReplaceAll The replace method to use on the matcher. ``` true - replaceAll(resourceNameReplacement); (default) false - replaceFirst(resourceNameReplacement); ``` ### protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") resourceNameReplacement The replacement used by the resource name matcher. ### protected [ServletContext](https://docs.oracle.com/javaee/7/api/javax/servlet/ServletContext.html "ServletContext") servletContext Servlet (or the web application) context. ### protected boolean verbose Controls almost all log output. Constructor Detail ------------------ ### public AbstractHttpServlet() Initializes all fields with default values. Method Detail ------------- ### protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") applyResourceNameMatcher([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri) ### protected void generateNamePrefixOnce() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [URLConnection](https://docs.oracle.com/javase/8/docs/api/java/net/URLConnection.html "URLConnection") getResourceConnection([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name) Interface method for ResourceContainer. This is used by the GroovyScriptEngine. ### protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getScriptUri([HttpServletRequest](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServletRequest.html "HttpServletRequest") request) Returns the include-aware uri of the script or template file. Parameters: `request` - the http request to analyze Returns: the include-aware uri either parsed from request attributes or hints provided by the servlet container ### protected [File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File") getScriptUriAsFile([HttpServletRequest](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServletRequest.html "HttpServletRequest") request) Parses the http request for the real script or template source file. Parameters: `request` - the http request to analyze Returns: a file object using an absolute file path name, or `null` if the servlet container cannot translate the virtual path to a real path for any reason (such as when the content is being made available from a .war archive). ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void init([ServletConfig](https://docs.oracle.com/javaee/7/api/javax/servlet/ServletConfig.html "ServletConfig") config) Overrides the generic init method to set some debug flags. throws: ServletException if init() method defined in super class javax.servlet.GenericServlet throws it Parameters: `config` - the servlet configuration provided by the container ### protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") removeNamePrefix([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name) ### protected void setVariables([ServletBinding](servletbinding) binding) Override this method to set your variables to the Groovy binding. All variables bound the binding are passed to the template source text, e.g. the HTML file, when the template is merged. The binding provided by TemplateServlet does already include some default variables. As of this writing, they are (copied from [ServletBinding](servletbinding "ServletBinding")): * "request" : HttpServletRequest * "response" : HttpServletResponse * "context" : ServletContext * "application" : ServletContext * "session" : request.getSession(false) And via implicit hard-coded keywords: * "out" : response.getWriter() * "sout" : response.getOutputStream() * "html" : new MarkupBuilder(response.getWriter()) The binding also provides convenient methods: * "forward(String path)" : request.getRequestDispatcher(path).forward(request, response); * "include(String path)" : request.getRequestDispatcher(path).include(request, response); * "redirect(String location)" : response.sendRedirect(location); Example binding all servlet context variables: ``` class MyServlet extends TemplateServlet { protected void setVariables(ServletBinding binding) { // Bind a simple variable binding.setVariable("answer", new Long(42)); // Bind all servlet context attributes... ServletContext context = (ServletContext) binding.getVariable("context"); Enumeration enumeration = context.getAttributeNames(); while (enumeration.hasMoreElements()) { String name = (String) enumeration.nextElement(); binding.setVariable(name, context.getAttribute(name)); } } } ``` Parameters: `binding` - to be modified	programming_docs
groovy [Java] Class TemplateServlet [Java] Class TemplateServlet ============================ * groovy.servlet.TemplateServlet ``` public class TemplateServlet extends [AbstractHttpServlet](abstracthttpservlet) ``` A generic servlet for serving (mostly HTML) templates. It delegates work to a `groovy.text.TemplateEngine` implementation processing HTTP requests. ### Usage `helloworld.html` is a headless HTML-like template ``` <html> <body> <% 3.times { %> Hello World! <% } %> <br> </body> </html> ``` Minimal `web.xml` example serving HTML-like templates ``` <web-app> <servlet> <servlet-name>template</servlet-name> <servlet-class>groovy.servlet.TemplateServlet</servlet-class> </servlet> <servlet-mapping> <servlet-name>template</servlet-name> <url-pattern>.html</url-pattern> </servlet-mapping> </web-app> ``` ### Template engine configuration By default, the TemplateServer uses the [SimpleTemplateEngine](../text/simpletemplateengine "SimpleTemplateEngine") which interprets JSP-like templates. The init parameter `template.engine` defines the fully qualified class name of the template to use: ``` template.engine = [empty] - equals groovy.text.SimpleTemplateEngine template.engine = groovy.text.SimpleTemplateEngine template.engine = groovy.text.GStringTemplateEngine template.engine = groovy.text.XmlTemplateEngine ``` Servlet Init Parameters ----------------------- ### Logging and extra-output options This implementation provides a verbosity flag switching log statements. The servlet init parameter name is: ``` generated.by = true(default) \| false ``` ### Groovy Source Encoding Parameter The following servlet init parameter name can be used to specify the encoding TemplateServlet will use to read the template groovy source files: ``` groovy.source.encoding ``` See Also:* [TemplateServlet.setVariables](templateservlet#setVariables(groovy.servlet.ServletBinding) "TemplateServlet.setVariables") Inherited fields \| Fields inherited from class \| Fields \| \| `class [AbstractHttpServlet](abstracthttpservlet)` \| `[CONTENT\_TYPE\_TEXT\_HTML](abstracthttpservlet#CONTENT_TYPE_TEXT_HTML), [INC\_PATH\_INFO](abstracthttpservlet#INC_PATH_INFO), [INC\_REQUEST\_URI](abstracthttpservlet#INC_REQUEST_URI), [INC\_SERVLET\_PATH](abstracthttpservlet#INC_SERVLET_PATH), [INIT\_PARAM\_RESOURCE\_NAME\_REGEX](abstracthttpservlet#INIT_PARAM_RESOURCE_NAME_REGEX), [INIT\_PARAM\_RESOURCE\_NAME\_REGEX\_FLAGS](abstracthttpservlet#INIT_PARAM_RESOURCE_NAME_REGEX_FLAGS), [encoding](abstracthttpservlet#encoding), [namePrefix](abstracthttpservlet#namePrefix), [reflection](abstracthttpservlet#reflection), [resourceNamePattern](abstracthttpservlet#resourceNamePattern), [resourceNameReplaceAll](abstracthttpservlet#resourceNameReplaceAll), [resourceNameReplacement](abstracthttpservlet#resourceNameReplacement), [servletContext](abstracthttpservlet#servletContext), [verbose](abstracthttpservlet#verbose)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[TemplateServlet](#TemplateServlet())()`Create new TemplateServlet. \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `protected [Template](../text/template)` \| `[getTemplate](#getTemplate(java.io.File))([File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File") file)`Gets the template created by the underlying engine parsing the request. \| \| \| `protected [Template](../text/template)` \| `[getTemplate](#getTemplate(java.net.URL))([URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html "URL") url)`Gets the template created by the underlying engine parsing the request. \| \| \| `public void` \| `[init](#init(javax.servlet.ServletConfig))([ServletConfig](https://docs.oracle.com/javaee/7/api/javax/servlet/ServletConfig.html "ServletConfig") config)`Initializes the servlet from hints the container passes. \| \| \| `protected [TemplateEngine](../text/templateengine)` \| `[initTemplateEngine](#initTemplateEngine(javax.servlet.ServletConfig))([ServletConfig](https://docs.oracle.com/javaee/7/api/javax/servlet/ServletConfig.html "ServletConfig") config)`Creates the template engine. \| \| \| `public void` \| `[service](#service(javax.servlet.http.HttpServletRequest,%20javax.servlet.http.HttpServletResponse))([HttpServletRequest](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServletRequest.html "HttpServletRequest") request, [HttpServletResponse](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServletResponse.html "HttpServletResponse") response)`Services the request with a response. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractHttpServlet](abstracthttpservlet)` \| `[applyResourceNameMatcher](abstracthttpservlet#applyResourceNameMatcher(java.lang.String)), [generateNamePrefixOnce](abstracthttpservlet#generateNamePrefixOnce()), [getResourceConnection](abstracthttpservlet#getResourceConnection(java.lang.String)), [getScriptUri](abstracthttpservlet#getScriptUri(javax.servlet.http.HttpServletRequest)), [getScriptUriAsFile](abstracthttpservlet#getScriptUriAsFile(javax.servlet.http.HttpServletRequest)), [init](abstracthttpservlet#init(javax.servlet.ServletConfig)), [removeNamePrefix](abstracthttpservlet#removeNamePrefix(java.lang.String)), [setVariables](abstracthttpservlet#setVariables(groovy.servlet.ServletBinding))` \| Constructor Detail ------------------ ### public TemplateServlet() Create new TemplateServlet. Method Detail ------------- ### protected [Template](../text/template) getTemplate([File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File") file) Gets the template created by the underlying engine parsing the request. This method looks up a simple (weak) hash map for an existing template object that matches the source file. If the source file didn't change in length and its last modified stamp hasn't changed compared to a precompiled template object, this template is used. Otherwise, there is no or an invalid template object cache entry, a new one is created by the underlying template engine. This new instance is put to the cache for consecutive calls. throws: ServletException If the request specified an invalid template source file Returns: The template that will produce the response text. Parameters: `file` - The file containing the template source. ### protected [Template](../text/template) getTemplate([URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html "URL") url) Gets the template created by the underlying engine parsing the request. This method looks up a simple (weak) hash map for an existing template object that matches the source URL. If there is no cache entry, a new one is created by the underlying template engine. This new instance is put to the cache for consecutive calls. throws: ServletException If the request specified an invalid template source URL Returns: The template that will produce the response text. Parameters: `url` - The URL containing the template source.. ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void init([ServletConfig](https://docs.oracle.com/javaee/7/api/javax/servlet/ServletConfig.html "ServletConfig") config) Initializes the servlet from hints the container passes. Delegates to sub-init methods and parses the following parameters: * "generatedBy" : boolean, appends "Generated by ..." to the HTML response text generated by this servlet. throws: ServletException if this method encountered difficulties Parameters: `config` - Passed by the servlet container. See Also: [TemplateServlet.initTemplateEngine](templateservlet#initTemplateEngine(javax.servlet.ServletConfig) "TemplateServlet.initTemplateEngine") ### protected [TemplateEngine](../text/templateengine) initTemplateEngine([ServletConfig](https://docs.oracle.com/javaee/7/api/javax/servlet/ServletConfig.html "ServletConfig") config) Creates the template engine. Called by [TemplateServlet.init](templateservlet#init(javax.servlet.ServletConfig) "TemplateServlet.init") and returns just `new groovy.text.SimpleTemplateEngine()` if the init parameter `template.engine` is not set by the container configuration. Parameters: `config` - Current servlet configuration passed by the container. Returns: The underlying template engine or `null` on error. ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void service([HttpServletRequest](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServletRequest.html "HttpServletRequest") request, [HttpServletResponse](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServletResponse.html "HttpServletResponse") response) Services the request with a response. First the request is parsed for the source file uri. If the specified file could not be found or can not be read an error message is sent as response. throws: IOException if an input or output error occurs while the servlet is handling the HTTP request throws: ServletException if the HTTP request cannot be handled Parameters: `request` - The http request. `response` - The http response. groovy [Java] Class ServletCategory [Java] Class ServletCategory ============================ * groovy.servlet.ServletCategory ``` public class ServletCategory extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Servlet support. Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[get](#get(javax.servlet.ServletContext,%20java.lang.String))([ServletContext](https://docs.oracle.com/javaee/7/api/javax/servlet/ServletContext.html "ServletContext") context, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") key)` \| \| \| `public static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[get](#get(javax.servlet.http.HttpSession,%20java.lang.String))([HttpSession](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpSession.html "HttpSession") session, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") key)` \| \| \| `public static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[get](#get(javax.servlet.ServletRequest,%20java.lang.String))([ServletRequest](https://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html "ServletRequest") request, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") key)` \| \| \| `public static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[get](#get(javax.servlet.jsp.PageContext,%20java.lang.String))([PageContext](https://docs.oracle.com/javaee/7/api/javax/servlet/jsp/PageContext.html "PageContext") context, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") key)` \| \| \| `public static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getAt](#getAt(javax.servlet.ServletContext,%20java.lang.String))([ServletContext](https://docs.oracle.com/javaee/7/api/javax/servlet/ServletContext.html "ServletContext") context, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") key)` \| \| \| `public static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getAt](#getAt(javax.servlet.http.HttpSession,%20java.lang.String))([HttpSession](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpSession.html "HttpSession") session, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") key)` \| \| \| `public static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getAt](#getAt(javax.servlet.ServletRequest,%20java.lang.String))([ServletRequest](https://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html "ServletRequest") request, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") key)` \| \| \| `public static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getAt](#getAt(javax.servlet.jsp.PageContext,%20java.lang.String))([PageContext](https://docs.oracle.com/javaee/7/api/javax/servlet/jsp/PageContext.html "PageContext") context, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") key)` \| \| \| `public static void` \| `[putAt](#putAt(javax.servlet.ServletContext,%20java.lang.String,%20java.lang.Object))([ServletContext](https://docs.oracle.com/javaee/7/api/javax/servlet/ServletContext.html "ServletContext") context, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") key, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| \| \| `public static void` \| `[putAt](#putAt(javax.servlet.http.HttpSession,%20java.lang.String,%20java.lang.Object))([HttpSession](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpSession.html "HttpSession") session, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") key, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| \| \| `public static void` \| `[putAt](#putAt(javax.servlet.ServletRequest,%20java.lang.String,%20java.lang.Object))([ServletRequest](https://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html "ServletRequest") request, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") key, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| \| \| `public static void` \| `[putAt](#putAt(javax.servlet.jsp.PageContext,%20java.lang.String,%20java.lang.Object))([PageContext](https://docs.oracle.com/javaee/7/api/javax/servlet/jsp/PageContext.html "PageContext") context, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") key, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| \| \| `public static void` \| `[set](#set(javax.servlet.ServletContext,%20java.lang.String,%20java.lang.Object))([ServletContext](https://docs.oracle.com/javaee/7/api/javax/servlet/ServletContext.html "ServletContext") context, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") key, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| \| \| `public static void` \| `[set](#set(javax.servlet.http.HttpSession,%20java.lang.String,%20java.lang.Object))([HttpSession](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpSession.html "HttpSession") session, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") key, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| \| \| `public static void` \| `[set](#set(javax.servlet.ServletRequest,%20java.lang.String,%20java.lang.Object))([ServletRequest](https://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html "ServletRequest") request, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") key, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| \| \| `public static void` \| `[set](#set(javax.servlet.jsp.PageContext,%20java.lang.String,%20java.lang.Object))([PageContext](https://docs.oracle.com/javaee/7/api/javax/servlet/jsp/PageContext.html "PageContext") context, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") key, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### public static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") get([ServletContext](https://docs.oracle.com/javaee/7/api/javax/servlet/ServletContext.html "ServletContext") context, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") key) ### public static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") get([HttpSession](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpSession.html "HttpSession") session, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") key) ### public static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") get([ServletRequest](https://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html "ServletRequest") request, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") key) ### public static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") get([PageContext](https://docs.oracle.com/javaee/7/api/javax/servlet/jsp/PageContext.html "PageContext") context, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") key) ### public static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getAt([ServletContext](https://docs.oracle.com/javaee/7/api/javax/servlet/ServletContext.html "ServletContext") context, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") key) ### public static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getAt([HttpSession](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpSession.html "HttpSession") session, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") key) ### public static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getAt([ServletRequest](https://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html "ServletRequest") request, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") key) ### public static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getAt([PageContext](https://docs.oracle.com/javaee/7/api/javax/servlet/jsp/PageContext.html "PageContext") context, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") key) ### public static void putAt([ServletContext](https://docs.oracle.com/javaee/7/api/javax/servlet/ServletContext.html "ServletContext") context, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") key, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) ### public static void putAt([HttpSession](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpSession.html "HttpSession") session, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") key, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) ### public static void putAt([ServletRequest](https://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html "ServletRequest") request, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") key, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) ### public static void putAt([PageContext](https://docs.oracle.com/javaee/7/api/javax/servlet/jsp/PageContext.html "PageContext") context, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") key, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) ### public static void set([ServletContext](https://docs.oracle.com/javaee/7/api/javax/servlet/ServletContext.html "ServletContext") context, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") key, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) ### public static void set([HttpSession](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpSession.html "HttpSession") session, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") key, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) ### public static void set([ServletRequest](https://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html "ServletRequest") request, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") key, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) ### public static void set([PageContext](https://docs.oracle.com/javaee/7/api/javax/servlet/jsp/PageContext.html "PageContext") context, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") key, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)	programming_docs
groovy [Java] Class ServletBinding [Java] Class ServletBinding =========================== * groovy.servlet.ServletBinding ``` public class ServletBinding extends [Binding](../lang/binding) ``` Servlet-specific binding extension to lazy load the writer or the output stream from the response. Eager variables --------------- * "request" : the `HttpServletRequest` object * "response" : the `HttpServletRequest` object * "context" : the `ServletContext` object * "application" : same as context * "session" : shorthand for `request.getSession(false)` - can be null! * "params" : map of all form parameters - can be empty * "headers" : map of all request header fields Lazy variables -------------- * "out" : `response.getWriter()` * "sout" : `response.getOutputStream()` * "html" : `new MarkupBuilder(response.getWriter())` - `expandEmptyElements` flag is set to true * "json" : `new JsonBuilder()` As per the Servlet specification, a call to `response.getWriter()` should not be done if a call to `response.getOutputStream()` has already occurred or the other way around. You may wonder then how the above lazy variables can possibly be provided - since setting them up would involve calling both of the above methods. The trick is catered for behind the scenes using lazy variables. Lazy bound variables can be requested without side effects; under the covers the writer and stream are wrapped. That means `response.getWriter()` is never directly called until some output is done using 'out' or 'html'. Once a write method call is done using either of these variable, then an attempt to write using 'sout' will cause an `IllegalStateException`. Similarly, if a write method call on 'sout' has been done already, then any further write method call on 'out' or 'html' will cause an `IllegalStateException`. Reserved internal variable names (see "Methods" below) ------------------------------------------------------ * "forward" * "include" * "redirect" If `response.getWriter()` is called directly (without using out), then a write method call on 'sout' will not cause the `IllegalStateException`, but it will still be invalid. It is the responsibility of the user of this class, to not to mix these different usage styles. The same applies to calling `response.getOutputStream()` and using 'out' or 'html'. Methods ------- * "forward(String path)" : `request.getRequestDispatcher(path).forward(request, response)` * "include(String path)" : `request.getRequestDispatcher(path).include(request, response)` * "redirect(String location)" : `response.sendRedirect(location)` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[ServletBinding](#ServletBinding(javax.servlet.http.HttpServletRequest,%20javax.servlet.http.HttpServletResponse,%20javax.servlet.ServletContext))([HttpServletRequest](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServletRequest.html "HttpServletRequest") request, [HttpServletResponse](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServletResponse.html "HttpServletResponse") response, [ServletContext](https://docs.oracle.com/javaee/7/api/javax/servlet/ServletContext.html "ServletContext") context)`Initializes a servlet binding. \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public void` \| `[forward](#forward(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") path)` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getVariable](#getVariable(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name)` Returns: a writer, an output stream, a markup builder or another requested object \| \| \| `public [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")` \| `[getVariables](#getVariables())()` \| \| \| `public void` \| `[include](#include(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") path)` \| \| \| `public void` \| `[redirect](#redirect(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") location)` \| \| \| `public void` \| `[setVariable](#setVariable(java.lang.String,%20java.lang.Object))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Binding](../lang/binding)` \| `[getProperty](../lang/binding#getProperty(java.lang.String)), [getVariable](../lang/binding#getVariable(java.lang.String)), [getVariables](../lang/binding#getVariables()), [hasVariable](../lang/binding#hasVariable(java.lang.String)), [removeVariable](../lang/binding#removeVariable(java.lang.String)), [setProperty](../lang/binding#setProperty(java.lang.String,%20java.lang.Object)), [setVariable](../lang/binding#setVariable(java.lang.String,%20java.lang.Object))` \| \| `class [GroovyObjectSupport](../lang/groovyobjectsupport)` \| `[getMetaClass](../lang/groovyobjectsupport#getMetaClass()), [setMetaClass](../lang/groovyobjectsupport#setMetaClass(groovy.lang.MetaClass))` \| Constructor Detail ------------------ ### public ServletBinding([HttpServletRequest](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServletRequest.html "HttpServletRequest") request, [HttpServletResponse](https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServletResponse.html "HttpServletResponse") response, [ServletContext](https://docs.oracle.com/javaee/7/api/javax/servlet/ServletContext.html "ServletContext") context) Initializes a servlet binding. Parameters: `request` - the HttpServletRequest object `response` - the HttpServletRequest object `context` - the ServletContext object Method Detail ------------- ### public void forward([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") path) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getVariable([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name) Returns: a writer, an output stream, a markup builder or another requested object ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") getVariables() ### public void include([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") path) ### public void redirect([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") location) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void setVariable([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) groovy [Java] Class Inspector [Java] Class Inspector ====================== * groovy.inspect.Inspector ``` public class Inspector extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` The Inspector provides a unified access to an object's information that can be determined by introspection. Nested Class Summary -------------------- Nested classes \| Modifiers \| Name \| Description \| \| `static class` \| `[Inspector.MemberComparator](inspector.membercomparator)` \| \| Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `static int` \| `[CLASS\_CLASS\_IDX](#CLASS_CLASS_IDX)` \| \| \| `static int` \| `[CLASS\_INTERFACE\_IDX](#CLASS_INTERFACE_IDX)` \| \| \| `static int` \| `[CLASS\_OTHER\_IDX](#CLASS_OTHER_IDX)` \| \| \| `static int` \| `[CLASS\_PACKAGE\_IDX](#CLASS_PACKAGE_IDX)` \| \| \| `static int` \| `[CLASS\_SUPERCLASS\_IDX](#CLASS_SUPERCLASS_IDX)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[GROOVY](#GROOVY)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[JAVA](#JAVA)` \| \| \| `static int` \| `[MEMBER\_DECLARER\_IDX](#MEMBER_DECLARER_IDX)` \| \| \| `static int` \| `[MEMBER\_EXCEPTIONS\_IDX](#MEMBER_EXCEPTIONS_IDX)` \| \| \| `static int` \| `[MEMBER\_MODIFIER\_IDX](#MEMBER_MODIFIER_IDX)` \| \| \| `static int` \| `[MEMBER\_NAME\_IDX](#MEMBER_NAME_IDX)` \| \| \| `static int` \| `[MEMBER\_ORIGIN\_IDX](#MEMBER_ORIGIN_IDX)` \| \| \| `static int` \| `[MEMBER\_PARAMS\_IDX](#MEMBER_PARAMS_IDX)` \| \| \| `static int` \| `[MEMBER\_TYPE\_IDX](#MEMBER_TYPE_IDX)` \| \| \| `static int` \| `[MEMBER\_VALUE\_IDX](#MEMBER_VALUE_IDX)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[NOT\_APPLICABLE](#NOT_APPLICABLE)` \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[objectUnderInspection](#objectUnderInspection)` \| \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[Inspector](#Inspector(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") objectUnderInspection)` Parameters: `objectUnderInspection` - must not be null \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")[]` \| `[fieldInfo](#fieldInfo(groovy.transform.Field))([Field](../transform/field) field)` \| \| \| `protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")[]` \| `[fieldInfo](#fieldInfo(groovy.lang.PropertyValue))([PropertyValue](../lang/propertyvalue) pv)` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")[]` \| `[getClassProps](#getClassProps())()`Get the Class Properties of the object under inspection. \| \| \| `protected [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")` \| `[getClassUnderInspection](#getClassUnderInspection())()` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[]` \| `[getMetaMethods](#getMetaMethods())()`Get info about instance and class Methods that are dynamically added through Groovy. \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[]` \| `[getMethods](#getMethods())()`Get info about usual Java instance and class Methods as well as Constructors. \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getObject](#getObject())()`Gets the object being inspected. \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[]` \| `[getPropertyInfo](#getPropertyInfo())()`Get info about Properties (Java and Groovy alike). \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[]` \| `[getPublicFields](#getPublicFields())()`Get info about usual Java public fields incl. constants. \| \| \| `public boolean` \| `[isGroovy](#isGroovy())()` \| \| \| `protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")[]` \| `[methodInfo](#methodInfo(java.lang.reflect.Method))([Method](https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Method.html "Method") method)` \| \| \| `protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")[]` \| `[methodInfo](#methodInfo(java.lang.reflect.Constructor))([Constructor](https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Constructor.html "Constructor") ctor)` \| \| \| `protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")[]` \| `[methodInfo](#methodInfo(groovy.lang.MetaMethod))([MetaMethod](../lang/metamethod) method)` \| \| \| `public static void` \| `[print](#print(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] memberInfo)` \| \| \| `public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[shortName](#shortName(java.lang.Class))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") clazz)` \| \| \| `public static [Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection")` \| `[sort](#sort(List))([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")> memberInfo)` \| \| \| `protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")[]` \| `[withoutNulls](#withoutNulls(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")[] toNormalize)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Field Detail ------------ ### public static final int CLASS\_CLASS\_IDX ### public static final int CLASS\_INTERFACE\_IDX ### public static final int CLASS\_OTHER\_IDX ### public static final int CLASS\_PACKAGE\_IDX ### public static final int CLASS\_SUPERCLASS\_IDX ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") GROOVY ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") JAVA ### public static final int MEMBER\_DECLARER\_IDX ### public static final int MEMBER\_EXCEPTIONS\_IDX ### public static final int MEMBER\_MODIFIER\_IDX ### public static final int MEMBER\_NAME\_IDX ### public static final int MEMBER\_ORIGIN\_IDX ### public static final int MEMBER\_PARAMS\_IDX ### public static final int MEMBER\_TYPE\_IDX ### public static final int MEMBER\_VALUE\_IDX ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") NOT\_APPLICABLE ### protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") objectUnderInspection Constructor Detail ------------------ ### public Inspector([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") objectUnderInspection) Parameters: `objectUnderInspection` - must not be null Method Detail ------------- ### protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")[] fieldInfo([Field](../transform/field) field) ### protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")[] fieldInfo([PropertyValue](../lang/propertyvalue) pv) ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")[] getClassProps() Get the Class Properties of the object under inspection. Returns: String array to be indexed by the CLASS\_xxx\_IDX constants ### protected [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") getClassUnderInspection() ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] getMetaMethods() Get info about instance and class Methods that are dynamically added through Groovy. Returns: Array of StringArrays that can be indexed with the MEMBER\_xxx\_IDX constants ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] getMethods() Get info about usual Java instance and class Methods as well as Constructors. Returns: Array of StringArrays that can be indexed with the MEMBER\_xxx\_IDX constants ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getObject() Gets the object being inspected. Returns: the object ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] getPropertyInfo() Get info about Properties (Java and Groovy alike). Returns: Array of StringArrays that can be indexed with the MEMBER\_xxx\_IDX constants ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] getPublicFields() Get info about usual Java public fields incl. constants. Returns: Array of StringArrays that can be indexed with the MEMBER\_xxx\_IDX constants ### public boolean isGroovy() ### protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")[] methodInfo([Method](https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Method.html "Method") method) ### protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")[] methodInfo([Constructor](https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Constructor.html "Constructor") ctor) ### protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")[] methodInfo([MetaMethod](../lang/metamethod) method) ### public static void print([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] memberInfo) ### public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") shortName([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") clazz) ### public static [Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection") sort([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")> memberInfo) ### protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")[] withoutNulls([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")[] toNormalize) groovy [Java] Class Inspector.MemberComparator [Java] Class Inspector.MemberComparator ======================================= * groovy.inspect.Inspector.MemberComparator All Implemented Interfaces and Traits: [Comparator](https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html "Comparator"), [Serializable](https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html "Serializable") ``` public static class Inspector.MemberComparator ``` Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public int` \| `[compare](#compare(java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") a, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") b)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public int compare([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") a, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") b)	programming_docs
groovy [Groovy] Class JavadocAssertionTestSuite [Groovy] Class JavadocAssertionTestSuite ======================================== * groovy.test.JavadocAssertionTestSuite ``` class JavadocAssertionTestSuite extends [TestSuite](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html "TestSuite") ``` `JavadocAssertionTestSuite` will dynamically create test cases from Groovy assertions placed within Javadoc comments. Assertions should be placed within an html tag with a `class="groovyTestCase"` attribute assignment. Example: ``` <pre class="groovyTestCase"> assert "example".size() == 7 </pre> ``` Source files will be read from the directory specified by the `javadocAssertion.src.dir` system property, including all files matching `javadocAssertion.src.pattern` and excluding files matching the `javadocAssertion.src.excludesPattern`. By default all `.java` and `.groovy` source files from `./src` will be scanned for assertions. You can also run this class as an application from the command line (assumes Groovy, JUnit and Ant are on the classpath). As an example: `java groovy.test.JavadocAssertionTestSuite src/main` Note: this class requires the Ant module at runtime. Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[SYSPROP\_SRC\_DIR](#SYSPROP_SRC_DIR)` \| The System Property to set as base directory for collection of Classes. \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[SYSPROP\_SRC\_EXCLUDES\_PATTERN](#SYSPROP_SRC_EXCLUDES_PATTERN)` \| The System Property to set as a filename excludes pattern for collection of Classes. \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[SYSPROP\_SRC\_PATTERN](#SYSPROP_SRC_PATTERN)` \| The System Property to set as the filename pattern for collection of Classes. \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[JavadocAssertionTestSuite](#JavadocAssertionTestSuite())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `static void` \| `[main](#main(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")[] args)` \| \| \| `static [Test](https://junit.org/junit4/javadoc/latest/junit/framework/Test.html "Test")` \| `[suite](#suite())()` \| \| \| `static [Test](https://junit.org/junit4/javadoc/latest/junit/framework/Test.html "Test")` \| `[suite](#suite(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") basedir)` \| \| \| `static [Test](https://junit.org/junit4/javadoc/latest/junit/framework/Test.html "Test")` \| `[suite](#suite(java.lang.String,%20java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") basedir, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") includePattern)` \| \| \| `static [Test](https://junit.org/junit4/javadoc/latest/junit/framework/Test.html "Test")` \| `[suite](#suite(java.lang.String,%20java.lang.String,%20java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") basedir, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") includePattern, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") excludePattern)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [TestSuite](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html "TestSuite")` \| `[getName](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#getName() "getName"), [run](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#run(junit.framework.TestResult) "run"), [toString](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#toString() "toString"), [setName](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#setName(java.lang.String) "setName"), [warning](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#warning(java.lang.String) "warning"), [tests](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#tests() "tests"), [getTestConstructor](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#getTestConstructor(java.lang.Class) "getTestConstructor"), [runTest](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#runTest(junit.framework.Test,%20junit.framework.TestResult) "runTest"), [addTestSuite](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#addTestSuite(java.lang.Class) "addTestSuite"), [addTest](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#addTest(junit.framework.Test) "addTest"), [countTestCases](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#countTestCases() "countTestCases"), [createTest](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#createTest(java.lang.Class,%20java.lang.String) "createTest"), [testAt](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#testAt(int) "testAt"), [testCount](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#testCount() "testCount"), [wait](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#wait(long,%20int) "wait"), [wait](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#wait() "wait"), [wait](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#wait(long) "wait"), [equals](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#equals(java.lang.Object) "equals"), [hashCode](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#hashCode() "hashCode"), [getClass](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#getClass() "getClass"), [notify](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#notify() "notify"), [notifyAll](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#notifyAll() "notifyAll")` \| Field Detail ------------ ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") SYSPROP\_SRC\_DIR The System Property to set as base directory for collection of Classes. The pattern will be used as an Ant fileset include basedir. Key is "javadocAssertion.src.dir". Defaults to the `./src` directory ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") SYSPROP\_SRC\_EXCLUDES\_PATTERN The System Property to set as a filename excludes pattern for collection of Classes. When non-empty, the pattern will be used as Regular Expression pattern applied with the find operator against each candidate file.path. Key is "javadocAssertion.src.excludesPattern". Default value is "". ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") SYSPROP\_SRC\_PATTERN The System Property to set as the filename pattern for collection of Classes. The pattern will be used as Regular Expression pattern applied with the find operator against each candidate file.path. Key is "javadocAssertion.src.pattern". Defaults to including all `.java` and `.groovy` files. Constructor Detail ------------------ ### JavadocAssertionTestSuite() Method Detail ------------- ### static void main([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")[] args) ### static [Test](https://junit.org/junit4/javadoc/latest/junit/framework/Test.html "Test") suite() ### static [Test](https://junit.org/junit4/javadoc/latest/junit/framework/Test.html "Test") suite([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") basedir) ### static [Test](https://junit.org/junit4/javadoc/latest/junit/framework/Test.html "Test") suite([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") basedir, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") includePattern) ### static [Test](https://junit.org/junit4/javadoc/latest/junit/framework/Test.html "Test") suite([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") basedir, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") includePattern, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") excludePattern) groovy [Groovy] Class StringTestUtil [Groovy] Class StringTestUtil ============================= * groovy.test.StringTestUtil ``` class StringTestUtil extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[StringTestUtil](#StringTestUtil())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `static void` \| `[assertMultilineStringsEqual](#assertMultilineStringsEqual(java.lang.String,%20java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") a, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") b)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### StringTestUtil() Method Detail ------------- ### static void assertMultilineStringsEqual([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") a, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") b) groovy [Groovy] Class GroovyShellTestCase [Groovy] Class GroovyShellTestCase ================================== * groovy.test.GroovyShellTestCase ``` class GroovyShellTestCase extends [GroovyTestCase](groovytestcase) ``` Groovy test case, which recreates internal GroovyShell in each setUp() Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `protected [GroovyShell](../lang/groovyshell)` \| `[shell](#shell)` \| \| Inherited fields \| Fields inherited from class \| Fields \| \| `class [GroovyTestCase](groovytestcase)` \| `[TEST\_SCRIPT\_NAME\_PREFIX](groovytestcase#TEST_SCRIPT_NAME_PREFIX), [log](groovytestcase#log)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[GroovyShellTestCase](#GroovyShellTestCase())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `protected [GroovyShell](../lang/groovyshell)` \| `[createNewShell](#createNewShell())()`Create new shell instance. \| \| \| `protected void` \| `[setUp](#setUp())()` \| \| \| `protected void` \| `[tearDown](#tearDown())()` \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[withBinding](#withBinding(java.util.Map,%20groovy.lang.Closure))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") map, [Closure](../lang/closure) closure)`Executes closure with given binding \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[withBinding](#withBinding(java.util.Map,%20java.lang.String))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") map, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") script)`Evaluates script with given binding \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [GroovyTestCase](groovytestcase)` \| `[assertArrayEquals](groovytestcase#assertArrayEquals(java.lang.Object,%20java.lang.Object)), [assertContains](groovytestcase#assertContains(char,%20char%5B%5D)), [assertContains](groovytestcase#assertContains(int,%20int%5B%5D)), [assertEquals](groovytestcase#assertEquals(java.lang.String,%20java.lang.Object,%20java.lang.Object)), [assertEquals](groovytestcase#assertEquals(java.lang.Object,%20java.lang.Object)), [assertEquals](groovytestcase#assertEquals(java.lang.String,%20java.lang.String)), [assertInspect](groovytestcase#assertInspect(java.lang.Object,%20java.lang.String)), [assertLength](groovytestcase#assertLength(int,%20char%5B%5D)), [assertLength](groovytestcase#assertLength(int,%20int%5B%5D)), [assertLength](groovytestcase#assertLength(int,%20java.lang.Object)), [assertScript](groovytestcase#assertScript(java.lang.String)), [assertToString](groovytestcase#assertToString(java.lang.Object,%20java.lang.String)), [fixEOLs](groovytestcase#fixEOLs(java.lang.String)), [getMethodName](groovytestcase#getMethodName()), [getName](groovytestcase#getName()), [getTestClassName](groovytestcase#getTestClassName()), [notYetImplemented](groovytestcase#notYetImplemented(java.lang.Object)), [notYetImplemented](groovytestcase#notYetImplemented()), [shouldFail](groovytestcase#shouldFail(groovy.lang.Closure)), [shouldFail](groovytestcase#shouldFail(java.lang.Class,%20groovy.lang.Closure)), [shouldFail](groovytestcase#shouldFail(java.lang.Class,%20java.lang.String)), [shouldFail](groovytestcase#shouldFail(java.lang.String)), [shouldFailWithCause](groovytestcase#shouldFailWithCause(java.lang.Class,%20groovy.lang.Closure))` \| Field Detail ------------ ### @[Delegate](../lang/delegate "Delegate") protected [GroovyShell](../lang/groovyshell) shell Constructor Detail ------------------ ### GroovyShellTestCase() Method Detail ------------- ### protected [GroovyShell](../lang/groovyshell) createNewShell() Create new shell instance. Overwrite it to customize ### protected void setUp() ### protected void tearDown() ### protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") withBinding([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") map, [Closure](../lang/closure) closure) Executes closure with given binding ### protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") withBinding([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") map, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") script) Evaluates script with given binding groovy [Java] Class GroovyTestCase [Java] Class GroovyTestCase =========================== * groovy.test.GroovyTestCase ``` public class GroovyTestCase extends [TestCase](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html "TestCase") ``` A JUnit 3 [TestCase](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html "TestCase") base class in Groovy. In case JUnit 4 is used, see [GroovyAssert](groovyassert "GroovyAssert"). See Also: [GroovyAssert](groovyassert "GroovyAssert") Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[TEST\_SCRIPT\_NAME\_PREFIX](#TEST_SCRIPT_NAME_PREFIX)` \| \| \| `protected static [Logger](https://docs.oracle.com/javase/8/docs/api/java/util/logging/Logger.html "Logger")` \| `[log](#log)` \| \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `protected void` \| `[assertArrayEquals](#assertArrayEquals(java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] expected, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] value)`Asserts that the arrays are equivalent and contain the same values \| \| \| `protected void` \| `[assertContains](#assertContains(char,%20char%5B%5D))(char expected, char[] array)`Asserts that the array of characters contains a given char \| \| \| `protected void` \| `[assertContains](#assertContains(int,%20int%5B%5D))(int expected, int[] array)`Asserts that the array of ints contains a given int \| \| \| `public static void` \| `[assertEquals](#assertEquals(java.lang.String,%20java.lang.Object,%20java.lang.Object))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") expected, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") actual)` \| \| \| `public static void` \| `[assertEquals](#assertEquals(java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") expected, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") actual)` \| \| \| `public static void` \| `[assertEquals](#assertEquals(java.lang.String,%20java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") expected, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") actual)` \| \| \| `protected void` \| `[assertInspect](#assertInspect(java.lang.Object,%20java.lang.String))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") expected)`Asserts that the value of inspect() on the given object matches the given text string \| \| \| `protected void` \| `[assertLength](#assertLength(int,%20char%5B%5D))(int length, char[] array)`Asserts that the array of characters has a given length \| \| \| `protected void` \| `[assertLength](#assertLength(int,%20int%5B%5D))(int length, int[] array)`Asserts that the array of ints has a given length \| \| \| `protected void` \| `[assertLength](#assertLength(int,%20java.lang.Object))(int length, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] array)`Asserts that the array of objects has a given length \| \| \| `protected void` \| `[assertScript](#assertScript(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") script)`see [GroovyAssert.assertScript](groovyassert#assertScript(String) "GroovyAssert.assertScript") \| \| \| `protected void` \| `[assertToString](#assertToString(java.lang.Object,%20java.lang.String))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") expected)`Asserts that the value of toString() on the given object matches the given text string \| \| \| `protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[fixEOLs](#fixEOLs(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") value)`Returns a copy of a string in which all EOLs are \n. \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getMethodName](#getMethodName())()` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getName](#getName())()`Overload the getName() method to make the test cases look more like AgileDox (thanks to Joe Walnes for this tip!) \| \| \| `protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getTestClassName](#getTestClassName())()` \| \| \| `public static boolean` \| `[notYetImplemented](#notYetImplemented(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") caller)`see [GroovyAssert.notYetImplemented](groovyassert#notYetImplemented(java.lang.Object) "GroovyAssert.notYetImplemented") \| \| \| `public boolean` \| `[notYetImplemented](#notYetImplemented())()`Convenience method for subclasses of GroovyTestCase, identical to ``` GroovyTestCase.notYetImplemented(this); ``` . \| \| \| `protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[shouldFail](#shouldFail(groovy.lang.Closure))([Closure](../lang/closure) code)`see [GroovyAssert.shouldFail](groovyassert#shouldFail(groovy.lang.Closure) "GroovyAssert.shouldFail") \| \| \| `protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[shouldFail](#shouldFail(java.lang.Class,%20groovy.lang.Closure))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") clazz, [Closure](../lang/closure) code)`see [GroovyAssert.shouldFail](groovyassert#shouldFail(Class,%20groovy.lang.Closure) "GroovyAssert.shouldFail") \| \| \| `protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[shouldFail](#shouldFail(java.lang.Class,%20java.lang.String))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") clazz, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") script)`see [GroovyAssert.shouldFail](groovyassert#shouldFail(Class,%20String) "GroovyAssert.shouldFail") \| \| \| `protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[shouldFail](#shouldFail(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") script)`see [GroovyAssert.shouldFail](groovyassert#shouldFail(String) "GroovyAssert.shouldFail") \| \| \| `protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[shouldFailWithCause](#shouldFailWithCause(java.lang.Class,%20groovy.lang.Closure))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") clazz, [Closure](../lang/closure) code)`see [GroovyAssert.shouldFailWithCause](groovyassert#shouldFailWithCause(Class,%20groovy.lang.Closure) "GroovyAssert.shouldFailWithCause") \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [TestCase](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html "TestCase")` \| `[getName](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#getName() "getName"), [run](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#run(junit.framework.TestResult) "run"), [run](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#run() "run"), [toString](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#toString() "toString"), [format](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#format(java.lang.String,%20java.lang.Object,%20java.lang.Object) "format"), [setName](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#setName(java.lang.String) "setName"), [fail](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#fail(java.lang.String) "fail"), [fail](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#fail() "fail"), [assertSame](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#assertSame(java.lang.String,%20java.lang.Object,%20java.lang.Object) "assertSame"), [assertSame](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#assertSame(java.lang.Object,%20java.lang.Object) "assertSame"), [assertTrue](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#assertTrue(java.lang.String,%20boolean) "assertTrue"), [assertTrue](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#assertTrue(boolean) "assertTrue"), [assertNotNull](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#assertNotNull(java.lang.Object) "assertNotNull"), [assertNotNull](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#assertNotNull(java.lang.String,%20java.lang.Object) "assertNotNull"), [countTestCases](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#countTestCases() "countTestCases"), [failNotSame](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#failNotSame(java.lang.String,%20java.lang.Object,%20java.lang.Object) "failNotSame"), [runBare](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#runBare() "runBare"), [assertFalse](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#assertFalse(java.lang.String,%20boolean) "assertFalse"), [assertFalse](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#assertFalse(boolean) "assertFalse"), [assertEquals](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#assertEquals(char,%20char) "assertEquals"), [assertEquals](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#assertEquals(short,%20short) "assertEquals"), [assertEquals](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#assertEquals(java.lang.String,%20short,%20short) "assertEquals"), [assertEquals](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#assertEquals(java.lang.String,%20int,%20int) "assertEquals"), [assertEquals](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#assertEquals(int,%20int) "assertEquals"), [assertEquals](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#assertEquals(boolean,%20boolean) "assertEquals"), [assertEquals](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#assertEquals(java.lang.String,%20double,%20double,%20double) "assertEquals"), [assertEquals](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#assertEquals(java.lang.String,%20java.lang.Object,%20java.lang.Object) "assertEquals"), [assertEquals](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#assertEquals(double,%20double,%20double) "assertEquals"), [assertEquals](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#assertEquals(java.lang.String,%20float,%20float,%20float) "assertEquals"), [assertEquals](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#assertEquals(java.lang.String,%20java.lang.String) "assertEquals"), [assertEquals](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#assertEquals(java.lang.String,%20java.lang.String,%20java.lang.String) "assertEquals"), [assertEquals](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#assertEquals(java.lang.Object,%20java.lang.Object) "assertEquals"), [assertEquals](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#assertEquals(java.lang.String,%20long,%20long) "assertEquals"), [assertEquals](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#assertEquals(long,%20long) "assertEquals"), [assertEquals](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#assertEquals(byte,%20byte) "assertEquals"), [assertEquals](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#assertEquals(java.lang.String,%20byte,%20byte) "assertEquals"), [assertEquals](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#assertEquals(java.lang.String,%20boolean,%20boolean) "assertEquals"), [assertEquals](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#assertEquals(java.lang.String,%20char,%20char) "assertEquals"), [assertEquals](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#assertEquals(float,%20float,%20float) "assertEquals"), [failSame](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#failSame(java.lang.String) "failSame"), [assertNull](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#assertNull(java.lang.String,%20java.lang.Object) "assertNull"), [assertNull](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#assertNull(java.lang.Object) "assertNull"), [failNotEquals](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#failNotEquals(java.lang.String,%20java.lang.Object,%20java.lang.Object) "failNotEquals"), [assertNotSame](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#assertNotSame(java.lang.String,%20java.lang.Object,%20java.lang.Object) "assertNotSame"), [assertNotSame](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#assertNotSame(java.lang.Object,%20java.lang.Object) "assertNotSame"), [wait](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#wait(long,%20int) "wait"), [wait](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#wait() "wait"), [wait](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#wait(long) "wait"), [equals](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#equals(java.lang.Object) "equals"), [hashCode](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#hashCode() "hashCode"), [getClass](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#getClass() "getClass"), [notify](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#notify() "notify"), [notifyAll](https://junit.org/junit4/javadoc/latest/junit/framework/TestCase.html#notifyAll() "notifyAll")` \| Field Detail ------------ ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") TEST\_SCRIPT\_NAME\_PREFIX ### protected static [Logger](https://docs.oracle.com/javase/8/docs/api/java/util/logging/Logger.html "Logger") log Method Detail ------------- ### protected void assertArrayEquals([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] expected, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] value) Asserts that the arrays are equivalent and contain the same values Parameters: expected value ### protected void assertContains(char expected, char[] array) Asserts that the array of characters contains a given char Parameters: `expected` - expected character to be found `array` - the array ### protected void assertContains(int expected, int[] array) Asserts that the array of ints contains a given int Parameters: `expected` - expected int `array` - the array ### public static void assertEquals([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") expected, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") actual) ### public static void assertEquals([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") expected, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") actual) ### public static void assertEquals([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") expected, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") actual) ### protected void assertInspect([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") expected) Asserts that the value of inspect() on the given object matches the given text string Parameters: `value` - the object to be output to the console `expected` - the expected String representation ### protected void assertLength(int length, char[] array) Asserts that the array of characters has a given length Parameters: `length` - expected length `array` - the array ### protected void assertLength(int length, int[] array) Asserts that the array of ints has a given length Parameters: `length` - expected length `array` - the array ### protected void assertLength(int length, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] array) Asserts that the array of objects has a given length Parameters: `length` - expected length `array` - the array ### protected void assertScript([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") script) see [GroovyAssert.assertScript](groovyassert#assertScript(String) "GroovyAssert.assertScript") ### protected void assertToString([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") expected) Asserts that the value of toString() on the given object matches the given text string Parameters: `value` - the object to be output to the console `expected` - the expected String representation ### protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") fixEOLs([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") value) Returns a copy of a string in which all EOLs are \n. ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getMethodName() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getName() Overload the getName() method to make the test cases look more like AgileDox (thanks to Joe Walnes for this tip!) ### protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getTestClassName() ### public static boolean notYetImplemented([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") caller) see [GroovyAssert.notYetImplemented](groovyassert#notYetImplemented(java.lang.Object) "GroovyAssert.notYetImplemented") ### public boolean notYetImplemented() Convenience method for subclasses of GroovyTestCase, identical to ``` GroovyTestCase.notYetImplemented(this); ``` . Returns: `false` when not itself already in the call stack See Also: [notYetImplemented(java.lang.Object)](#notYetImplemented(java.lang.Object)) ### protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") shouldFail([Closure](../lang/closure) code) see [GroovyAssert.shouldFail](groovyassert#shouldFail(groovy.lang.Closure) "GroovyAssert.shouldFail") ### protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") shouldFail([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") clazz, [Closure](../lang/closure) code) see [GroovyAssert.shouldFail](groovyassert#shouldFail(Class,%20groovy.lang.Closure) "GroovyAssert.shouldFail") ### protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") shouldFail([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") clazz, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") script) see [GroovyAssert.shouldFail](groovyassert#shouldFail(Class,%20String) "GroovyAssert.shouldFail") ### protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") shouldFail([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") script) see [GroovyAssert.shouldFail](groovyassert#shouldFail(String) "GroovyAssert.shouldFail") ### protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") shouldFailWithCause([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") clazz, [Closure](../lang/closure) code) see [GroovyAssert.shouldFailWithCause](groovyassert#shouldFailWithCause(Class,%20groovy.lang.Closure) "GroovyAssert.shouldFailWithCause")	programming_docs
groovy [Java] Class GroovyTestSuite [Java] Class GroovyTestSuite ============================ * groovy.test.GroovyTestSuite ``` public class GroovyTestSuite extends [TestSuite](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html "TestSuite") ``` A TestSuite which will run a Groovy unit test case inside any Java IDE either as a unit test case or as an application. You can specify the GroovyUnitTest to run by running this class as an application and specifying the script to run on the command line. `java groovy.test.GroovyTestSuite src/test/Foo.groovy` Or to run the test suite as a unit test suite in an IDE you can use the 'test' system property to define the test script to run. e.g. pass this into the JVM when the unit test plugin runs... `-Dtest=src/test/Foo.groovy` Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `protected static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[file](#file)` \| \| \| `protected [GroovyClassLoader](../lang/groovyclassloader)` \| `[loader](#loader)` \| \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")` \| `[compile](#compile(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") fileName)` \| \| \| `public void` \| `[loadTestSuite](#loadTestSuite())()` \| \| \| `public static void` \| `[main](#main(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")[] args)` \| \| \| `public static [Test](https://junit.org/junit4/javadoc/latest/junit/framework/Test.html "Test")` \| `[suite](#suite())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [TestSuite](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html "TestSuite")` \| `[getName](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#getName() "getName"), [run](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#run(junit.framework.TestResult) "run"), [toString](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#toString() "toString"), [setName](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#setName(java.lang.String) "setName"), [warning](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#warning(java.lang.String) "warning"), [tests](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#tests() "tests"), [getTestConstructor](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#getTestConstructor(java.lang.Class) "getTestConstructor"), [runTest](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#runTest(junit.framework.Test,%20junit.framework.TestResult) "runTest"), [addTestSuite](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#addTestSuite(java.lang.Class) "addTestSuite"), [addTest](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#addTest(junit.framework.Test) "addTest"), [countTestCases](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#countTestCases() "countTestCases"), [createTest](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#createTest(java.lang.Class,%20java.lang.String) "createTest"), [testAt](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#testAt(int) "testAt"), [testCount](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#testCount() "testCount"), [wait](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#wait(long,%20int) "wait"), [wait](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#wait() "wait"), [wait](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#wait(long) "wait"), [equals](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#equals(java.lang.Object) "equals"), [hashCode](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#hashCode() "hashCode"), [getClass](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#getClass() "getClass"), [notify](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#notify() "notify"), [notifyAll](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#notifyAll() "notifyAll")` \| Field Detail ------------ ### protected static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") file ### protected final [GroovyClassLoader](../lang/groovyclassloader) loader Method Detail ------------- ### public [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") compile([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") fileName) ### public void loadTestSuite() ### public static void main([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")[] args) ### public static [Test](https://junit.org/junit4/javadoc/latest/junit/framework/Test.html "Test") suite() groovy [Groovy] Class JavadocAssertionTestBuilder [Groovy] Class JavadocAssertionTestBuilder ========================================== * groovy.test.JavadocAssertionTestBuilder ``` class JavadocAssertionTestBuilder extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` `JavadocAssertionTestBuilder` will dynamically create a test cases from Groovy assertions placed within the Javadoc comments of a source file. Assertions should be placed within an html tag with a `class="groovyTestCase"` attribute assignment. Example: ``` <pre class="groovyTestCase"> assert "example".size() == 7 </pre> ``` When extracting the code for the test, single-line snippets of code without braces within a {`@code` ...} tag will have the javadoc `code` tag stripped. Similarly, html entities are converted back when extracting code, so `<` and `>` will be converted to `<` and `>`. Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[JavadocAssertionTestBuilder](#JavadocAssertionTestBuilder())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")` \| `[buildTest](#buildTest(java.lang.String,%20java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") filename, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") code)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### JavadocAssertionTestBuilder() Method Detail ------------- ### [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") buildTest([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") filename, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") code) groovy [Groovy] Class GroovyLogTestCase [Groovy] Class GroovyLogTestCase ================================ * groovy.test.GroovyLogTestCase ``` class GroovyLogTestCase extends [GroovyTestCase](groovytestcase) ``` Helper class to spoof log entries as produced by calling arbitrary code. This allows non-intrusive testing of dependent objects without explicitly using Mock objects as long as those dependent objects do some proper logging. As a measure of last resort, it can be used on MetaClass to spoof it's log entries on 'invokeMethod'. Inherited fields \| Fields inherited from class \| Fields \| \| `class [GroovyTestCase](groovytestcase)` \| `[TEST\_SCRIPT\_NAME\_PREFIX](groovytestcase#TEST_SCRIPT_NAME_PREFIX), [log](groovytestcase#log)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[GroovyLogTestCase](#GroovyLogTestCase())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[stringLog](#stringLog(java.util.logging.Level,%20java.lang.String,%20groovy.lang.Closure))([Level](https://docs.oracle.com/javase/8/docs/api/java/util/logging/Level.html "Level") level, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") qualifier, [Closure](../lang/closure) yield)`Execute the given Closure with the according level for the Logger that is qualified by the qualifier and return the log output as a String. \| \| \| `static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[withLevel](#withLevel(java.util.logging.Level,%20java.lang.String,%20groovy.lang.Closure))([Level](https://docs.oracle.com/javase/8/docs/api/java/util/logging/Level.html "Level") level, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") qualifier, [Closure](../lang/closure) yield)`Execute the given Closure with the according level for the Logger that is qualified by the qualifier. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [GroovyTestCase](groovytestcase)` \| `[assertArrayEquals](groovytestcase#assertArrayEquals(java.lang.Object,%20java.lang.Object)), [assertContains](groovytestcase#assertContains(char,%20char%5B%5D)), [assertContains](groovytestcase#assertContains(int,%20int%5B%5D)), [assertEquals](groovytestcase#assertEquals(java.lang.String,%20java.lang.Object,%20java.lang.Object)), [assertEquals](groovytestcase#assertEquals(java.lang.Object,%20java.lang.Object)), [assertEquals](groovytestcase#assertEquals(java.lang.String,%20java.lang.String)), [assertInspect](groovytestcase#assertInspect(java.lang.Object,%20java.lang.String)), [assertLength](groovytestcase#assertLength(int,%20char%5B%5D)), [assertLength](groovytestcase#assertLength(int,%20int%5B%5D)), [assertLength](groovytestcase#assertLength(int,%20java.lang.Object)), [assertScript](groovytestcase#assertScript(java.lang.String)), [assertToString](groovytestcase#assertToString(java.lang.Object,%20java.lang.String)), [fixEOLs](groovytestcase#fixEOLs(java.lang.String)), [getMethodName](groovytestcase#getMethodName()), [getName](groovytestcase#getName()), [getTestClassName](groovytestcase#getTestClassName()), [notYetImplemented](groovytestcase#notYetImplemented(java.lang.Object)), [notYetImplemented](groovytestcase#notYetImplemented()), [shouldFail](groovytestcase#shouldFail(groovy.lang.Closure)), [shouldFail](groovytestcase#shouldFail(java.lang.Class,%20groovy.lang.Closure)), [shouldFail](groovytestcase#shouldFail(java.lang.Class,%20java.lang.String)), [shouldFail](groovytestcase#shouldFail(java.lang.String)), [shouldFailWithCause](groovytestcase#shouldFailWithCause(java.lang.Class,%20groovy.lang.Closure))` \| Constructor Detail ------------------ ### GroovyLogTestCase() Method Detail ------------- ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") stringLog([Level](https://docs.oracle.com/javase/8/docs/api/java/util/logging/Level.html "Level") level, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") qualifier, [Closure](../lang/closure) yield) Execute the given Closure with the according level for the Logger that is qualified by the qualifier and return the log output as a String. Qualifiers are usually package or class names. Existing log level and handlers are restored after execution. ### static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") withLevel([Level](https://docs.oracle.com/javase/8/docs/api/java/util/logging/Level.html "Level") level, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") qualifier, [Closure](../lang/closure) yield) Execute the given Closure with the according level for the Logger that is qualified by the qualifier. Qualifiers are usually package or class names. The log level is restored after execution. groovy [Java] Class GroovyAssert [Java] Class GroovyAssert ========================= * groovy.test.GroovyAssert ``` public class GroovyAssert extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` `GroovyAssert` contains a set of static assertion and test helper methods for JUnit 4+. They augment the kind of helper methods found in JUnit 4's [Assert](https://junit.org/junit4/javadoc/latest/org/junit/Assert.html "Assert") class. JUnit 3 users typically don't use these methods but instead, the equivalent methods in [GroovyTestCase](groovytestcase "GroovyTestCase"). `GroovyAssert` methods can either be used by fully qualifying the static method like: ``` groovy.test.GroovyAssert.shouldFail { ... } ``` or by importing the static methods with one ore more static imports: ``` import static groovy.test.GroovyAssert.shouldFail ``` Backwards compatibility note: Prior to Groovy 4, `GroovyAssert` extended JUnit 4's [Assert](https://junit.org/junit4/javadoc/latest/org/junit/Assert.html "Assert") class. This meant that you could statically import static methods from that class via `GroovyAssert`, e.g.: ``` import static groovy.test.GroovyAssert.assertNotNull ``` This is generally regarded as a code smell since inheritance is primarily to do with instance methods. From Groovy 4, you should import such methods directly, e.g.: ``` import static org.junit.Assert.assertNotNull ``` See Also: [GroovyTestCase](groovytestcase "GroovyTestCase") Since: 2.3 Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[TEST\_SCRIPT\_NAME\_PREFIX](#TEST_SCRIPT_NAME_PREFIX)` \| \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public static void` \| `[assertScript](#assertScript(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") script)`Asserts that the script runs without any exceptions \| \| \| `public static void` \| `[assertScript](#assertScript(groovy.lang.GroovyShell,%20java.lang.String))([GroovyShell](../lang/groovyshell) shell, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") script)`Asserts that the script runs using the given shell without any exceptions \| \| \| `public static void` \| `[fail](#fail(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message)` \| \| \| `protected static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[genericScriptName](#genericScriptName())()` Returns: a generic script name to be used by `GroovyShell#evaluate` calls. \| \| \| `public static boolean` \| `[isAtLeastJdk](#isAtLeastJdk(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") specVersion)` Returns: true if the JDK version is at least the version given by specVersion (e.g. "1.8", "9.0") \| \| \| `public static boolean` \| `[notYetImplemented](#notYetImplemented(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") caller)` \| \| \| `public static [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html "Throwable")` \| `[shouldFail](#shouldFail(groovy.lang.Closure))([Closure](../lang/closure) code)`Asserts that the given code closure fails when it is evaluated \| \| \| `public static [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html "Throwable")` \| `[shouldFail](#shouldFail(java.lang.Class,%20groovy.lang.Closure))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") clazz, [Closure](../lang/closure) code)`Asserts that the given code closure fails when it is evaluated and that a particular type of exception is thrown. \| \| \| `public static [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html "Throwable")` \| `[shouldFail](#shouldFail(java.lang.Class,%20java.lang.String))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") clazz, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") script)`Asserts that the given script fails when it is evaluated and that a particular type of exception is thrown. \| \| \| `public static [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html "Throwable")` \| `[shouldFail](#shouldFail(groovy.lang.GroovyShell,%20java.lang.Class,%20java.lang.String))([GroovyShell](../lang/groovyshell) shell, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") clazz, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") script)`Asserts that the given script fails when it is evaluated using the given shell and that a particular type of exception is thrown. \| \| \| `public static [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html "Throwable")` \| `[shouldFail](#shouldFail(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") script)`Asserts that the given script fails when it is evaluated \| \| \| `public static [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html "Throwable")` \| `[shouldFail](#shouldFail(groovy.lang.GroovyShell,%20java.lang.String))([GroovyShell](../lang/groovyshell) shell, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") script)`Asserts that the given script fails when it is evaluated using the given shell \| \| \| `public static [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html "Throwable")` \| `[shouldFailWithCause](#shouldFailWithCause(java.lang.Class,%20groovy.lang.Closure))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") expectedCause, [Closure](../lang/closure) code)`Asserts that the given code closure fails when it is evaluated and that a particular Exception type can be attributed to the cause. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Field Detail ------------ ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") TEST\_SCRIPT\_NAME\_PREFIX Method Detail ------------- ### public static void assertScript([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") script) Asserts that the script runs without any exceptions Parameters: `script` - the script that should pass without any exception thrown ### public static void assertScript([GroovyShell](../lang/groovyshell) shell, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") script) Asserts that the script runs using the given shell without any exceptions Parameters: `shell` - the shell to use to evaluate the script `script` - the script that should pass without any exception thrown ### public static void fail([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message) ### protected static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") genericScriptName() Returns: a generic script name to be used by `GroovyShell#evaluate` calls. ### public static boolean isAtLeastJdk([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") specVersion) Returns: true if the JDK version is at least the version given by specVersion (e.g. "1.8", "9.0") Since: 2.5.7 ### public static boolean notYetImplemented([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") caller) Runs the calling JUnit test again and fails only if it unexpectedly runs. This is helpful for tests that don't currently work but should work one day, when the tested functionality has been implemented. The right way to use it for JUnit 3 is: ``` public void testXXX() { if (GroovyAssert.notYetImplemented(this)) return; ... the real (now failing) unit test } ``` or for JUnit 4 ``` @Test public void XXX() { if (GroovyAssert.notYetImplemented(this)) return; ... the real (now failing) unit test } ``` Idea copied from HtmlUnit (many thanks to Marc Guillemot). Future versions maybe available in the JUnit distribution. Returns: `false` when not itself already in the call stack ### public static [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html "Throwable") shouldFail([Closure](../lang/closure) code) Asserts that the given code closure fails when it is evaluated Parameters: `code` - the code expected to fail Returns: the caught exception ### public static [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html "Throwable") shouldFail([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") clazz, [Closure](../lang/closure) code) Asserts that the given code closure fails when it is evaluated and that a particular type of exception is thrown. Parameters: `clazz` - the class of the expected exception `code` - the closure that should fail Returns: the caught exception ### public static [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html "Throwable") shouldFail([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") clazz, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") script) Asserts that the given script fails when it is evaluated and that a particular type of exception is thrown. Parameters: `clazz` - the class of the expected exception `script` - the script that should fail Returns: the caught exception ### public static [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html "Throwable") shouldFail([GroovyShell](../lang/groovyshell) shell, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") clazz, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") script) Asserts that the given script fails when it is evaluated using the given shell and that a particular type of exception is thrown. Parameters: `shell` - the shell to use to evaluate the script `clazz` - the class of the expected exception `script` - the script that should fail Returns: the caught exception ### public static [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html "Throwable") shouldFail([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") script) Asserts that the given script fails when it is evaluated Parameters: `script` - the script expected to fail Returns: the caught exception ### public static [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html "Throwable") shouldFail([GroovyShell](../lang/groovyshell) shell, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") script) Asserts that the given script fails when it is evaluated using the given shell Parameters: `shell` - the shell to use to evaluate the script `script` - the script expected to fail Returns: the caught exception ### public static [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html "Throwable") shouldFailWithCause([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") expectedCause, [Closure](../lang/closure) code) Asserts that the given code closure fails when it is evaluated and that a particular Exception type can be attributed to the cause. The expected exception class is compared recursively with any nested exceptions using getCause() until either a match is found or no more nested exceptions exist. If a match is found, the matching exception is returned otherwise the method will fail. Parameters: `expectedCause` - the class of the expected exception `code` - the closure that should fail Returns: the cause	programming_docs
groovy [Java] Class AllTestSuite [Java] Class AllTestSuite ========================= * groovy.test.AllTestSuite ``` public class AllTestSuite extends [TestSuite](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html "TestSuite") ``` AllTestSuite can be used in extension of GroovyTestSuite to execute TestCases written in Groovy from inside a Java IDE. AllTestSuite collects all files below a given directory that comply to a given pattern. From these files, a TestSuite is constructed that can be run via an IDE graphical Test runner. The files are assumed to be Groovy source files and be either a TestCase or a Script that can be wrapped transparently into a TestCase. The directory and the pattern can be set via System properties (see this classes' constants for details.) When setting the log level of this class to FINEST, all file loading will be logged. See also groovy.test.AllTestSuiteTest.groovy Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[SYSPROP\_TEST\_DIR](#SYSPROP_TEST_DIR)` \| The System Property to set as base directory for collection of Test Cases. \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[SYSPROP\_TEST\_EXCLUDES\_PATTERN](#SYSPROP_TEST_EXCLUDES_PATTERN)` \| The System Property to set as a filename excludes pattern for collection of Test Cases. \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[SYSPROP\_TEST\_PATTERN](#SYSPROP_TEST_PATTERN)` \| The System Property to set as the filename pattern for collection of Test Cases. \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `protected [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")` \| `[compile](#compile(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") filename)` \| \| \| `protected void` \| `[loadTest](#loadTest(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") filename)` \| \| \| `public static [Test](https://junit.org/junit4/javadoc/latest/junit/framework/Test.html "Test")` \| `[suite](#suite())()` \| \| \| `public static [Test](https://junit.org/junit4/javadoc/latest/junit/framework/Test.html "Test")` \| `[suite](#suite(java.lang.String,%20java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") basedir, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") pattern)` \| \| \| `public static [Test](https://junit.org/junit4/javadoc/latest/junit/framework/Test.html "Test")` \| `[suite](#suite(java.lang.String,%20java.lang.String,%20java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") basedir, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") pattern, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") excludesPattern)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [TestSuite](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html "TestSuite")` \| `[getName](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#getName() "getName"), [run](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#run(junit.framework.TestResult) "run"), [toString](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#toString() "toString"), [setName](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#setName(java.lang.String) "setName"), [warning](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#warning(java.lang.String) "warning"), [tests](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#tests() "tests"), [getTestConstructor](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#getTestConstructor(java.lang.Class) "getTestConstructor"), [runTest](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#runTest(junit.framework.Test,%20junit.framework.TestResult) "runTest"), [addTestSuite](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#addTestSuite(java.lang.Class) "addTestSuite"), [addTest](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#addTest(junit.framework.Test) "addTest"), [countTestCases](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#countTestCases() "countTestCases"), [createTest](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#createTest(java.lang.Class,%20java.lang.String) "createTest"), [testAt](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#testAt(int) "testAt"), [testCount](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#testCount() "testCount"), [wait](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#wait(long,%20int) "wait"), [wait](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#wait() "wait"), [wait](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#wait(long) "wait"), [equals](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#equals(java.lang.Object) "equals"), [hashCode](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#hashCode() "hashCode"), [getClass](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#getClass() "getClass"), [notify](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#notify() "notify"), [notifyAll](https://junit.org/junit4/javadoc/latest/junit/framework/TestSuite.html#notifyAll() "notifyAll")` \| Field Detail ------------ ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") SYSPROP\_TEST\_DIR The System Property to set as base directory for collection of Test Cases. The pattern will be used as an Ant fileset include basedir. Key is "groovy.test.dir". Default value is "./test/". ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") SYSPROP\_TEST\_EXCLUDES\_PATTERN The System Property to set as a filename excludes pattern for collection of Test Cases. When non-empty, the pattern will be used as Regular Expression pattern applied with the find operator against each candidate file.path. Key is "groovy.test.excludesPattern". Default value is "". ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") SYSPROP\_TEST\_PATTERN The System Property to set as the filename pattern for collection of Test Cases. The pattern will be used as Regular Expression pattern applied with the find operator against each candidate file.path. Key is "groovy.test.pattern". Default value is "Test.groovy". Method Detail ------------- ### protected [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") compile([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") filename) ### @[SuppressWarnings](https://docs.oracle.com/javase/8/docs/api/java/lang/SuppressWarnings.html "SuppressWarnings")("unchecked") protected void loadTest([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") filename) ### public static [Test](https://junit.org/junit4/javadoc/latest/junit/framework/Test.html "Test") suite() ### public static [Test](https://junit.org/junit4/javadoc/latest/junit/framework/Test.html "Test") suite([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") basedir, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") pattern) ### public static [Test](https://junit.org/junit4/javadoc/latest/junit/framework/Test.html "Test") suite([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") basedir, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") pattern, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") excludesPattern) groovy [Java] Annotation Type NotYetImplemented [Java] Annotation Type NotYetImplemented ======================================== * groovy.test.NotYetImplemented ``` @[Documented](https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Documented.html "Documented") @[Retention](https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html "Retention")(RetentionPolicy.RUNTIME) @[Target](https://docs.groovy-lang.org/docs/ant/api/org/apache/tools/ant/Target.html "Target")({ElementType.METHOD}) @[GroovyASTTransformationClass](../../org/codehaus/groovy/transform/groovyasttransformationclass "GroovyASTTransformationClass")("org.apache.groovy.test.transform.NotYetImplementedASTTransformation") public @interface NotYetImplemented ``` Method annotation used to invert test case results. If a JUnit 3/4/5 test case method is annotated with `@NotYetImplemented`, the test will fail if no test failure occurs and it will pass if a test failure occurs. This is helpful for tests that don't currently work but should work one day, when the tested functionality has been implemented. Note: JUnit 3 users should use the optional `exception` attribute, e.g. `@NotYetImplemented(exception=junit.framework.AssertionFailedError)`. Since: 3.0.0 Element Summary --------------- Optional Element Summary \| Type \| Name and Description \| \| `[Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<? extends [AssertionError](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html "AssertionError")>` \| `[exception](#exception)`If defined, tests which unexpectedly pass will throw this exception. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Element Detail -------------- ### public [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<? extends [AssertionError](https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html "AssertionError")> exception If defined, tests which unexpectedly pass will throw this exception. The supplied exception class should have a constructor variant accepting a single String error message. Since: 3.0.3 Default: AssertionError.class groovy [Java] Class ObservableSet.ElementRemovedEvent [Java] Class ObservableSet.ElementRemovedEvent ============================================== * groovy.util.ObservableSet.ElementRemovedEvent ``` public static class ObservableSet.ElementRemovedEvent extends [ElementEvent](../../elementevent) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[ElementRemovedEvent](#ElementRemovedEvent(java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") source, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| Constructor Detail ------------------ ### public ElementRemovedEvent([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") source, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) groovy [Java] Interface ObjectGraphBuilder.NewInstanceResolver [Java] Interface ObjectGraphBuilder.NewInstanceResolver ======================================================= ``` public interface ObjectGraphBuilder.NewInstanceResolver ``` Strategy for creating new instances of a class. Useful for plug-in calls to non-default constructors. Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(java.lang.Class,%20java.util.Map))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") klass, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)`Create a new instance of Class klass. \| Method Detail ------------- ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") klass, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) Create a new instance of Class klass. Parameters: `klass` - the resolved class name `attributes` - the attribute Map available for the node groovy [Java] Class ObservableMap.PropertyAddedEvent [Java] Class ObservableMap.PropertyAddedEvent ============================================= * groovy.util.ObservableMap.PropertyAddedEvent ``` public static class ObservableMap.PropertyAddedEvent extends [PropertyEvent](../../propertyevent) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[PropertyAddedEvent](#PropertyAddedEvent(java.lang.Object,%20java.lang.String,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") source, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") propertyName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newValue)` \| Constructor Detail ------------------ ### public PropertyAddedEvent([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") source, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") propertyName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newValue) groovy [Java] Interface ObjectGraphBuilder.RelationNameResolver [Java] Interface ObjectGraphBuilder.RelationNameResolver ======================================================== ``` public interface ObjectGraphBuilder.RelationNameResolver ``` Strategy for resolving a relationship property name. Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[resolveChildRelationName](#resolveChildRelationName(java.lang.String,%20java.lang.Object,%20java.lang.String,%20java.lang.Object))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") parentName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") childName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child)`Returns the mapping name of child -> parent \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[resolveParentRelationName](#resolveParentRelationName(java.lang.String,%20java.lang.Object,%20java.lang.String,%20java.lang.Object))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") parentName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") childName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child)`Returns the mapping name of parent -> child \| Method Detail ------------- ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") resolveChildRelationName([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") parentName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") childName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child) Returns the mapping name of child -> parent Parameters: `parentName` - the name of the parent node `parent` - the parent node `childName` - the name of the child node `child` - the child node ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") resolveParentRelationName([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") parentName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") childName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child) Returns the mapping name of parent -> child Parameters: `parentName` - the name of the parent node `parent` - the parent node `childName` - the name of the child node `child` - the child node groovy [Java] Interface ObjectGraphBuilder.ReferenceResolver [Java] Interface ObjectGraphBuilder.ReferenceResolver ===================================================== ``` public interface ObjectGraphBuilder.ReferenceResolver ``` Strategy for picking the correct synthetic reference identifier. Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getReferenceFor](#getReferenceFor(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") nodeName)`Returns the name of the property that references another node. \| Method Detail ------------- ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getReferenceFor([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") nodeName) Returns the name of the property that references another node. Parameters: `nodeName` - the name of the node groovy [Java] Class ObjectGraphBuilder.DefaultChildPropertySetter [Java] Class ObjectGraphBuilder.DefaultChildPropertySetter ========================================================== * groovy.util.ObjectGraphBuilder.DefaultChildPropertySetter All Implemented Interfaces and Traits: [ObjectGraphBuilder.ChildPropertySetter](objectgraphbuilder.childpropertysetter) ``` public static class ObjectGraphBuilder.DefaultChildPropertySetter ``` Default impl that calls parent.propertyName = child If parent.propertyName is a Collection it will try to add child to the collection. Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public void` \| `[setChild](#setChild(java.lang.Object,%20java.lang.Object,%20java.lang.String,%20java.lang.String))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") parentName, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") propertyName)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void setChild([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") parentName, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") propertyName)	programming_docs
groovy [Java] Enum ObservableMap.ChangeType [Java] Enum ObservableMap.ChangeType ==================================== * groovy.util.ObservableMap.ChangeType ``` public enum ObservableMap.ChangeType ``` Enum Constants Summary ---------------------- Enum constants classes \| Enum constant \| Description \| \| `[ADDED](#ADDED)` \| \| \| `[CLEARED](#CLEARED)` \| \| \| `[MULTI](#MULTI)` \| \| \| `[NONE](#NONE)` \| \| \| `[REMOVED](#REMOVED)` \| \| \| `[UPDATED](#UPDATED)` \| \| Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newValue](#newValue)` \| \| \| `static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[oldValue](#oldValue)` \| \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public static [ChangeType](../../changetype)` \| `[resolve](#resolve(int))(int ordinal)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Enum Constant Detail -------------------- ### public [ObservableMap.ChangeType](observablemap.changetype) ADDED ### public [ObservableMap.ChangeType](observablemap.changetype) CLEARED ### public [ObservableMap.ChangeType](observablemap.changetype) MULTI ### public [ObservableMap.ChangeType](observablemap.changetype) NONE ### public [ObservableMap.ChangeType](observablemap.changetype) REMOVED ### public [ObservableMap.ChangeType](observablemap.changetype) UPDATED Field Detail ------------ ### public static final [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newValue ### public static final [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") oldValue Method Detail ------------- ### public static [ChangeType](../../changetype) resolve(int ordinal) groovy [Java] Class Node [Java] Class Node ================= * groovy.util.Node All Implemented Interfaces and Traits: [Serializable](https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html "Serializable"), [Cloneable](https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html "Cloneable") ``` public class Node extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") implements [Serializable](https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html "Serializable"), [Cloneable](https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html "Cloneable") ``` Represents an arbitrary tree node which can be used for structured metadata or any arbitrary XML-like tree. A node can have a name, a value and an optional Map of attributes. Typically the name is a String and a value is either a String or a List of other Nodes, though the types are extensible to provide a flexible structure, e.g. you could use a QName as the name which includes a namespace URI and a local name. Or a JMX ObjectName etc. So this class can represent metadata like `{foo a=1 b="abc"}` or nested metadata like `{foo a=1 b="123" { bar x=12 text="hello" }}` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[Node](#Node(groovy.util.Node,%20java.lang.Object))([Node](node) parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name)`Creates a new Node named `name` and if a parent is supplied, adds the newly created node as a child of the parent. \| \| `[Node](#Node(groovy.util.Node,%20java.lang.Object,%20java.lang.Object))([Node](node) parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)`Creates a new Node named `name` with value `value` and if a parent is supplied, adds the newly created node as a child of the parent. \| \| `[Node](#Node(groovy.util.Node,%20java.lang.Object,%20java.util.Map))([Node](node) parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)`Creates a new Node named `name` with attributes specified in the `attributes` Map. \| \| `[Node](#Node(groovy.util.Node,%20java.lang.Object,%20java.util.Map,%20java.lang.Object))([Node](node) parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)`Creates a new Node named `name` with value `value` and with attributes specified in the `attributes` Map. \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public boolean` \| `[append](#append(groovy.util.Node))([Node](node) child)`Appends a child to the current node. \| \| \| `public [Node](node)` \| `[appendNode](#appendNode(java.lang.Object,%20java.util.Map))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)`Creates a new node as a child of the current node. \| \| \| `public [Node](node)` \| `[appendNode](#appendNode(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name)`Creates a new node as a child of the current node. \| \| \| `public [Node](node)` \| `[appendNode](#appendNode(java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)`Creates a new node as a child of the current node. \| \| \| `public [Node](node)` \| `[appendNode](#appendNode(java.lang.Object,%20java.util.Map,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)`Creates a new node as a child of the current node. \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[attribute](#attribute(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") key)`Provides lookup of attributes by key. \| \| \| `public [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")` \| `[attributes](#attributes())()`Returns a `Map` of the attributes of the node or an empty `Map` if the node does not have any attributes. \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")` \| `[breadthFirst](#breadthFirst())()`Provides a collection of all the nodes in the tree using a breadth-first preorder traversal. \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")` \| `[breadthFirst](#breadthFirst(boolean))(boolean preorder)`Provides a collection of all the nodes in the tree using a breadth-first traversal. \| \| \| `public void` \| `[breadthFirst](#breadthFirst(groovy.lang.Closure))([Closure](../lang/closure) c)`Calls the provided closure for all the nodes in the tree using a breadth-first preorder traversal. \| \| \| `public void` \| `[breadthFirst](#breadthFirst(Map,%20groovy.lang.Closure))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")> options, [Closure](../lang/closure) c)`Calls the provided closure for all the nodes in the tree using a breadth-first traversal. \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")` \| `[children](#children())()`Returns a `List` of the nodes children. \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[clone](#clone())()`Creates a new Node with the same name, no parent, shallow cloned attributes and if the value is a NodeList, a (deep) clone of those nodes. \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")` \| `[depthFirst](#depthFirst())()`Provides a collection of all the nodes in the tree using a depth-first preorder traversal. \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")` \| `[depthFirst](#depthFirst(boolean))(boolean preorder)`Provides a collection of all the nodes in the tree using a depth-first traversal. \| \| \| `public void` \| `[depthFirst](#depthFirst(groovy.lang.Closure))([Closure](../lang/closure) c)`Provides a collection of all the nodes in the tree using a depth-first preorder traversal. \| \| \| `public void` \| `[depthFirst](#depthFirst(Map,%20groovy.lang.Closure))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")> options, [Closure](../lang/closure) c)`Provides a collection of all the nodes in the tree using a depth-first traversal. \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[get](#get(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") key)`Provides lookup of elements by non-namespaced name \| \| \| `public [NodeList](nodelist)` \| `[getAt](#getAt(groovy.namespace.QName))([QName](../namespace/qname) name)`Provides lookup of elements by QName. \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getAttribute](#getAttribute(java.lang.Object,%20java.lang.String))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") attribute)` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getProperty](#getProperty(java.lang.Object,%20java.lang.String))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") property)` \| \| \| `public [Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html "Iterator")` \| `[iterator](#iterator())()`Returns an `Iterator` of the children of the node. \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>` \| `[localText](#localText())()`Returns the list of any direct String nodes of this node. \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[name](#name())()`Returns an `Object` representing the name of the node. \| \| \| `public [Node](node)` \| `[parent](#parent())()`Returns the parent of the node. \| \| \| `public void` \| `[plus](#plus(groovy.lang.Closure))([Closure](../lang/closure) c)`Adds sibling nodes (defined using builder-style notation via a Closure) after the current node. \| \| \| `public void` \| `[print](#print(java.io.PrintWriter))([PrintWriter](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html "PrintWriter") out)`Writes the node to the specified `PrintWriter`. \| \| \| `public boolean` \| `[remove](#remove(groovy.util.Node))([Node](node) child)`Removes a child of the current node. \| \| \| `public [Node](node)` \| `[replaceNode](#replaceNode(groovy.lang.Closure))([Closure](../lang/closure) c)`Replaces the current node with nodes defined using builder-style notation via a Closure. \| \| \| `public [Node](node)` \| `[replaceNode](#replaceNode(groovy.util.Node))([Node](node) n)`Replaces the current node with the supplied node. \| \| \| `public void` \| `[setAttribute](#setAttribute(java.lang.Object,%20java.lang.String,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") attribute, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newValue)` \| \| \| `protected static void` \| `[setMetaClass](#setMetaClass(groovy.lang.MetaClass,%20java.lang.Class))([MetaClass](../lang/metaclass) metaClass, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") nodeClass)`Extension point for subclasses to override the metaclass. \| \| \| `protected void` \| `[setParent](#setParent(groovy.util.Node))([Node](node) parent)`Adds or replaces the parent of the node. \| \| \| `public void` \| `[setProperty](#setProperty(java.lang.Object,%20java.lang.String,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") property, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newValue)` \| \| \| `public void` \| `[setValue](#setValue(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)`Adds or replaces the value of the node. \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[text](#text())()`Returns the textual representation of the current node and all its child nodes. \| \| \| `public [BigDecimal](https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html "BigDecimal")` \| `[toBigDecimal](#toBigDecimal())()`Converts the text of this GPathResult to a BigDecimal object. \| \| \| `public [BigInteger](https://docs.oracle.com/javase/8/docs/api/java/math/BigInteger.html "BigInteger")` \| `[toBigInteger](#toBigInteger())()`Converts the text of this GPathResult to a BigInteger object. \| \| \| `public [Double](https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html "Double")` \| `[toDouble](#toDouble())()`Converts the text of this GPathResult to a Double object. \| \| \| `public [Float](https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html "Float")` \| `[toFloat](#toFloat())()`Converts the text of this GPathResult to a Float object. \| \| \| `public [Integer](https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html "Integer")` \| `[toInteger](#toInteger())()`Converts the text of this GPathResult to a Integer object. \| \| \| `public [Long](https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html "Long")` \| `[toLong](#toLong())()`Converts the text of this GPathResult to a Long object. \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[toString](#toString())()` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[value](#value())()`Returns an `Object` representing the value of the node. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public Node([Node](node) parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name) Creates a new Node named `name` and if a parent is supplied, adds the newly created node as a child of the parent. Parameters: `parent` - the parent node or null if no parent `name` - the name of the node ### public Node([Node](node) parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) Creates a new Node named `name` with value `value` and if a parent is supplied, adds the newly created node as a child of the parent. Parameters: `parent` - the parent node or null if no parent `name` - the name of the node `value` - the Node value, e.g. some text but in general any Object ### public Node([Node](node) parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) Creates a new Node named `name` with attributes specified in the `attributes` Map. If a parent is supplied, the newly created node is added as a child of the parent. Parameters: `parent` - the parent node or null if no parent `name` - the name of the node `attributes` - a Map of name-value pairs ### public Node([Node](node) parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) Creates a new Node named `name` with value `value` and with attributes specified in the `attributes` Map. If a parent is supplied, the newly created node is added as a child of the parent. Parameters: `parent` - the parent node or null if no parent `name` - the name of the node `attributes` - a Map of name-value pairs `value` - the Node value, e.g. some text but in general any Object Method Detail ------------- ### public boolean append([Node](node) child) Appends a child to the current node. Parameters: `child` - the child to append Returns: `true` ### public [Node](node) appendNode([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) Creates a new node as a child of the current node. Parameters: `name` - the name of the new node `attributes` - the attributes of the new node Returns: the newly created `Node` ### public [Node](node) appendNode([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name) Creates a new node as a child of the current node. Parameters: `name` - the name of the new node Returns: the newly created `Node` ### public [Node](node) appendNode([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) Creates a new node as a child of the current node. Parameters: `name` - the name of the new node `value` - the value of the new node Returns: the newly created `Node` ### public [Node](node) appendNode([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) Creates a new node as a child of the current node. Parameters: `name` - the name of the new node `attributes` - the attributes of the new node `value` - the value of the new node Returns: the newly created `Node` ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") attribute([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") key) Provides lookup of attributes by key. Parameters: `key` - the key of interest Returns: the attribute matching the key or `null` if no match exists ### public [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes() Returns a `Map` of the attributes of the node or an empty `Map` if the node does not have any attributes. Returns: the attributes of the node ### public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") breadthFirst() Provides a collection of all the nodes in the tree using a breadth-first preorder traversal. Returns: the list of (breadth-first) ordered nodes ### public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") breadthFirst(boolean preorder) Provides a collection of all the nodes in the tree using a breadth-first traversal. Parameters: `preorder` - if false, a postorder breadth-first traversal will be performed Returns: the list of (breadth-first) ordered nodes Since: 2.5.0 ### public void breadthFirst([Closure](../lang/closure) c) Calls the provided closure for all the nodes in the tree using a breadth-first preorder traversal. Parameters: `c` - the closure to run for each node (a one or two parameter can be used; if one parameter is given the closure will be passed the node, for a two param closure the second parameter will be the level). Since: 2.5.0 ### public void breadthFirst([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")> options, [Closure](../lang/closure) c) Calls the provided closure for all the nodes in the tree using a breadth-first traversal. A boolean 'preorder' options is supported. Parameters: `options` - map containing options `c` - the closure to run for each node (a one or two parameter can be used; if one parameter is given the closure will be passed the node, for a two param closure the second parameter will be the level). Since: 2.5.0 ### public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") children() Returns a `List` of the nodes children. Returns: the nodes children ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") clone() Creates a new Node with the same name, no parent, shallow cloned attributes and if the value is a NodeList, a (deep) clone of those nodes. Returns: the clone ### public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") depthFirst() Provides a collection of all the nodes in the tree using a depth-first preorder traversal. Returns: the list of (depth-first) ordered nodes ### public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") depthFirst(boolean preorder) Provides a collection of all the nodes in the tree using a depth-first traversal. Parameters: `preorder` - if false, a postorder depth-first traversal will be performed Returns: the list of (depth-first) ordered nodes Since: 2.5.0 ### public void depthFirst([Closure](../lang/closure) c) Provides a collection of all the nodes in the tree using a depth-first preorder traversal. Parameters: `c` - the closure to run for each node (a one or two parameter can be used; if one parameter is given the closure will be passed the node, for a two param closure the second parameter will be the level). Since: 2.5.0 ### public void depthFirst([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")> options, [Closure](../lang/closure) c) Provides a collection of all the nodes in the tree using a depth-first traversal. A boolean 'preorder' options is supported. Parameters: `options` - map containing options `c` - the closure to run for each node (a one or two parameter can be used; if one parameter is given the closure will be passed the node, for a two param closure the second parameter will be the level). Since: 2.5.0 ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") get([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") key) Provides lookup of elements by non-namespaced name Parameters: `key` - the name (or shortcut key) of the node(s) of interest Returns: the nodes which match key ### public [NodeList](nodelist) getAt([QName](../namespace/qname) name) Provides lookup of elements by QName. Parameters: `name` - the QName of interest Returns: the nodes matching name ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getAttribute([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") attribute) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getProperty([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") property) ### public [Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html "Iterator") iterator() Returns an `Iterator` of the children of the node. Returns: the iterator of the nodes children ### public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> localText() Returns the list of any direct String nodes of this node. Returns: the list of String values from this node Since: 2.3.0 ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name() Returns an `Object` representing the name of the node. Returns: the name or `null` if name is empty ### public [Node](node) parent() Returns the parent of the node. Returns: the parent or `null` for the root node ### public void plus([Closure](../lang/closure) c) Adds sibling nodes (defined using builder-style notation via a Closure) after the current node. Parameters: `c` - A Closure defining the new sibling nodes to add using builder-style notation. ### public void print([PrintWriter](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html "PrintWriter") out) Writes the node to the specified `PrintWriter`. Parameters: `out` - the writer receiving the output ### public boolean remove([Node](node) child) Removes a child of the current node. Parameters: `child` - the child to remove Returns: `true` if the param was a child of the current node ### public [Node](node) replaceNode([Closure](../lang/closure) c) Replaces the current node with nodes defined using builder-style notation via a Closure. Parameters: `c` - A Closure defining the new nodes using builder-style notation. Returns: the original now replaced node ### public [Node](node) replaceNode([Node](node) n) Replaces the current node with the supplied node. Parameters: `n` - the new Node Returns: the original now replaced node ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void setAttribute([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") attribute, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newValue) ### protected static void setMetaClass([MetaClass](../lang/metaclass) metaClass, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") nodeClass) Extension point for subclasses to override the metaclass. The default one supports the property and @ attribute notations. Parameters: `metaClass` - the original metaclass `nodeClass` - the class whose metaclass we wish to override (this class or a subclass) ### protected void setParent([Node](node) parent) Adds or replaces the parent of the node. Parameters: `parent` - the new parent of the node ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void setProperty([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") property, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newValue) ### public void setValue([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) Adds or replaces the value of the node. Parameters: `value` - the new value of the node ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text() Returns the textual representation of the current node and all its child nodes. Returns: the text value of the node including child text ### public [BigDecimal](https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html "BigDecimal") toBigDecimal() Converts the text of this GPathResult to a BigDecimal object. Returns: the GPathResult, converted to a `BigDecimal` ### public [BigInteger](https://docs.oracle.com/javase/8/docs/api/java/math/BigInteger.html "BigInteger") toBigInteger() Converts the text of this GPathResult to a BigInteger object. Returns: the GPathResult, converted to a `BigInteger` ### public [Double](https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html "Double") toDouble() Converts the text of this GPathResult to a Double object. Returns: the GPathResult, converted to a `Double` ### public [Float](https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html "Float") toFloat() Converts the text of this GPathResult to a Float object. Returns: the GPathResult, converted to a `Float` ### public [Integer](https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html "Integer") toInteger() Converts the text of this GPathResult to a Integer object. Returns: the GPathResult, converted to a `Integer` ### public [Long](https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html "Long") toLong() Converts the text of this GPathResult to a Long object. Returns: the GPathResult, converted to a `Long` ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") toString() ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value() Returns an `Object` representing the value of the node. Returns: the value or `null` if value is empty	programming_docs
groovy [Java] Interface ResourceConnector [Java] Interface ResourceConnector ================================== ``` public interface ResourceConnector ``` Base interface for customizing where resources can be found for the `GroovyScriptEngine`. Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [URLConnection](https://docs.oracle.com/javase/8/docs/api/java/net/URLConnection.html "URLConnection")` \| `[getResourceConnection](#getResourceConnection(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name)`Retrieve a URLConnection to a script referenced by name. \| Method Detail ------------- ### public [URLConnection](https://docs.oracle.com/javase/8/docs/api/java/net/URLConnection.html "URLConnection") getResourceConnection([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name) Retrieve a URLConnection to a script referenced by name. throws: ResourceException Parameters: name groovy [Java] Class OrderBy<T> [Java] Class OrderBy<T> ======================= * groovy.util.OrderBy All Implemented Interfaces and Traits: [Comparator](https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html "Comparator"), [Serializable](https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html "Serializable") ``` public class OrderBy<T> extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") implements [Comparator](https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html "Comparator"), [Serializable](https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html "Serializable") ``` A helper class for sorting objects via a closure to return the field or operation on which to sort. Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[OrderBy](#OrderBy())()` \| \| `[OrderBy](#OrderBy(boolean))(boolean equalityCheck)` \| \| `[OrderBy](#OrderBy(groovy.lang.Closure))([Closure](../lang/closure) closure)` \| \| `[OrderBy](#OrderBy(groovy.lang.Closure,%20boolean))([Closure](../lang/closure) closure, boolean equalityCheck)` \| \| `[OrderBy](#OrderBy(List))([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Closure](../lang/closure "Closure")> closures)` \| \| `[OrderBy](#OrderBy(List,%20boolean))([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Closure](../lang/closure "Closure")> closures, boolean equalityCheck)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public void` \| `[add](#add(groovy.lang.Closure))([Closure](../lang/closure) closure)` \| \| \| `public int` \| `[compare](#compare(T,%20T))(T object1, T object2)` \| \| \| `public boolean` \| `[isEqualityCheck](#isEqualityCheck())()` \| \| \| `public void` \| `[setEqualityCheck](#setEqualityCheck(boolean))(boolean equalityCheck)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public OrderBy() ### public OrderBy(boolean equalityCheck) ### public OrderBy([Closure](../lang/closure) closure) ### public OrderBy([Closure](../lang/closure) closure, boolean equalityCheck) ### public OrderBy([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Closure](../lang/closure "Closure")> closures) ### public OrderBy([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Closure](../lang/closure "Closure")> closures, boolean equalityCheck) Method Detail ------------- ### public void add([Closure](../lang/closure) closure) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public int compare(T object1, T object2) ### public boolean isEqualityCheck() ### public void setEqualityCheck(boolean equalityCheck) groovy [Java] Class Eval [Java] Class Eval ================= * groovy.util.Eval ``` public class Eval extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[me](#me(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") expression)`Evaluates the specified String expression and returns the result. \| \| \| `public static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[me](#me(java.lang.String,%20java.lang.Object,%20java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") symbol, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") expression)`Evaluates the specified String expression and makes the parameter available inside the script, returning the result. \| \| \| `public static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[x](#x(java.lang.Object,%20java.lang.String))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") x, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") expression)`Evaluates the specified String expression and makes the parameter available inside the script bound to a variable named 'x', returning the result. \| \| \| `public static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[xy](#xy(java.lang.Object,%20java.lang.Object,%20java.lang.String))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") x, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") y, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") expression)`Evaluates the specified String expression and makes the first two parameters available inside the script bound to variables named 'x' and 'y' respectively, returning the result. \| \| \| `public static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[xyz](#xyz(java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20java.lang.String))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") x, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") y, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") z, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") expression)`Evaluates the specified String expression and makes the first three parameters available inside the script bound to variables named 'x', 'y', and 'z' respectively, returning the result. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### public static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") me([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") expression) Evaluates the specified String expression and returns the result. For example: ``` assert Eval.me(' 2 * 4 + 2') == 10 ``` throws: CompilationFailedException if expression is not valid Groovy Parameters: `expression` - the Groovy expression to evaluate Returns: the result of the expression ### public static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") me([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") symbol, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") expression) Evaluates the specified String expression and makes the parameter available inside the script, returning the result. For example, this code binds the 'x' variable: ``` assert Eval.me('x', 2, ' x * 4 + 2') == 10 ``` throws: CompilationFailedException if expression is not valid Groovy Parameters: `expression` - the Groovy expression to evaluate Returns: the result of the expression ### public static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") x([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") x, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") expression) Evaluates the specified String expression and makes the parameter available inside the script bound to a variable named 'x', returning the result. For example, this code executes without failure: ``` assert Eval.x(2, ' x * 4 + 2') == 10 ``` throws: CompilationFailedException if expression is not valid Groovy Parameters: `expression` - the Groovy expression to evaluate Returns: the result of the expression ### public static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") xy([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") x, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") y, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") expression) Evaluates the specified String expression and makes the first two parameters available inside the script bound to variables named 'x' and 'y' respectively, returning the result. For example, this code executes without failure: ``` assert Eval.xy(2, 4, ' x * y + 2') == 10 ``` throws: CompilationFailedException if expression is not valid Groovy Parameters: `expression` - the Groovy expression to evaluate Returns: the result of the expression ### public static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") xyz([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") x, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") y, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") z, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") expression) Evaluates the specified String expression and makes the first three parameters available inside the script bound to variables named 'x', 'y', and 'z' respectively, returning the result. For example, this code executes without failure: ``` assert Eval.xyz(2, 4, 2, ' x * y + z') == 10 ``` throws: CompilationFailedException if expression is not valid Groovy Parameters: `expression` - the Groovy expression to evaluate Returns: the result of the expression groovy [Java] Class ObservableList.ElementEvent [Java] Class ObservableList.ElementEvent ======================================== * groovy.util.ObservableList.ElementEvent ``` public static abstract class ObservableList.ElementEvent extends [PropertyChangeEvent](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html "PropertyChangeEvent") ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[ElementEvent](#ElementEvent(java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20int,%20ChangeType))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") source, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") oldValue, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newValue, int index, [ChangeType](../../changetype) type)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [ChangeType](../../changetype)` \| `[getChangeType](#getChangeType())()` \| \| \| `public int` \| `[getIndex](#getIndex())()` \| \| \| `public int` \| `[getType](#getType())()` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getTypeAsString](#getTypeAsString())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [PropertyChangeEvent](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html "PropertyChangeEvent")` \| `[toString](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html#toString() "toString"), [getPropertyName](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html#getPropertyName() "getPropertyName"), [getOldValue](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html#getOldValue() "getOldValue"), [getPropagationId](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html#getPropagationId() "getPropagationId"), [setPropagationId](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html#setPropagationId(java.lang.Object) "setPropagationId"), [getNewValue](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html#getNewValue() "getNewValue"), [getSource](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html#getSource() "getSource"), [wait](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html#equals(java.lang.Object) "equals"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public ElementEvent([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") source, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") oldValue, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newValue, int index, [ChangeType](../../changetype) type) Method Detail ------------- ### public [ChangeType](../../changetype) getChangeType() ### public int getIndex() ### public int getType() ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getTypeAsString() groovy [Java] Class ObservableSet.ObservableIterator<E> [Java] Class ObservableSet.ObservableIterator<E> ================================================ * groovy.util.ObservableSet.ObservableIterator All Implemented Interfaces and Traits: [Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html "Iterator") ``` protected class ObservableSet.ObservableIterator<E> ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[ObservableIterator](#ObservableIterator(Iterator))([Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html "Iterator")<E> iterDelegate)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html "Iterator")<E>` \| `[getDelegate](#getDelegate())()` \| \| \| `public boolean` \| `[hasNext](#hasNext())()` \| \| \| `public E` \| `[next](#next())()` \| \| \| `public void` \| `[remove](#remove())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public ObservableIterator([Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html "Iterator")<E> iterDelegate) Method Detail ------------- ### public [Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html "Iterator")<E> getDelegate() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean hasNext() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public E next() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void remove()	programming_docs
groovy [Java] Class ObservableSet.ElementClearedEvent [Java] Class ObservableSet.ElementClearedEvent ============================================== * groovy.util.ObservableSet.ElementClearedEvent ``` public static class ObservableSet.ElementClearedEvent extends [ElementEvent](../../elementevent) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[ElementClearedEvent](#ElementClearedEvent(java.lang.Object,%20java.util.List))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") source, [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") values)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")` \| `[getValues](#getValues())()` \| Constructor Detail ------------------ ### public ElementClearedEvent([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") source, [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") values) Method Detail ------------- ### public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") getValues() groovy [Java] Class ObservableList.ElementAddedEvent [Java] Class ObservableList.ElementAddedEvent ============================================= * groovy.util.ObservableList.ElementAddedEvent ``` public static class ObservableList.ElementAddedEvent extends [ElementEvent](../../elementevent) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[ElementAddedEvent](#ElementAddedEvent(java.lang.Object,%20java.lang.Object,%20int))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") source, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newValue, int index)` \| Constructor Detail ------------------ ### public ElementAddedEvent([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") source, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newValue, int index) groovy [Java] Class ObjectGraphBuilder.DefaultReferenceResolver [Java] Class ObjectGraphBuilder.DefaultReferenceResolver ======================================================== * groovy.util.ObjectGraphBuilder.DefaultReferenceResolver All Implemented Interfaces and Traits: [ReferenceResolver](../../referenceresolver) ``` public static class ObjectGraphBuilder.DefaultReferenceResolver ``` Default impl, always returns 'refId' Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getReferenceFor](#getReferenceFor(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") nodeName)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getReferenceFor([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") nodeName) groovy [Java] Class ObservableList.ElementRemovedEvent [Java] Class ObservableList.ElementRemovedEvent =============================================== * groovy.util.ObservableList.ElementRemovedEvent ``` public static class ObservableList.ElementRemovedEvent extends [ElementEvent](../../elementevent) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[ElementRemovedEvent](#ElementRemovedEvent(java.lang.Object,%20java.lang.Object,%20int))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") source, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, int index)` \| Constructor Detail ------------------ ### public ElementRemovedEvent([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") source, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, int index) groovy [Java] Class GroovyCollections [Java] Class GroovyCollections ============================== * groovy.util.GroovyCollections ``` public class GroovyCollections extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` A Collections utility class Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public static [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")` \| `[combinations](#combinations(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] collections)`Finds all combinations of items from the given collections. \| \| \| `public static [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")` \| `[combinations](#combinations(java.lang.Iterable))([Iterable](https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html "Iterable") collections)`Finds all combinations of items from the given Iterable aggregate of collections. \| \| `<T>` \| `public static [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<T>>` \| `[inits](#inits(Iterable))([Iterable](https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html "Iterable")<T> collections)` \| \| `<T>` \| `public static T` \| `[max](#max(T))(T[] items)`Selects the maximum value found in an array of items, so max([2, 4, 6] as Object[]) == 6. \| \| `<T>` \| `public static T` \| `[max](#max(Iterable))([Iterable](https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html "Iterable")<T> items)`Selects the maximum value found in an Iterable. \| \| `<T>` \| `public static T` \| `[min](#min(T))(T[] items)`Selects the minimum value found in an array of items, so min([2, 4, 6] as Object[]) == 2. \| \| `<T>` \| `public static T` \| `[min](#min(Iterable))([Iterable](https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html "Iterable")<T> items)`Selects the minimum value found in an Iterable of items. \| \| `<T>` \| `public static [Set](https://docs.oracle.com/javase/8/docs/api/java/util/Set.html "Set")<[List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<T>>` \| `[subsequences](#subsequences(List))([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<T> items)`Finds all non-null subsequences of a list. \| \| \| `public static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[sum](#sum(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] items)`Sums all the items from an array of items. \| \| \| `public static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[sum](#sum(Iterable))([Iterable](https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html "Iterable")<?> items)`Sums all the given items. \| \| `<T>` \| `public static [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<T>>` \| `[tails](#tails(Iterable))([Iterable](https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html "Iterable")<T> collections)` \| \| \| `public static [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")` \| `[transpose](#transpose(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] lists)`Transposes an array of lists. \| \| \| `public static [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")` \| `[transpose](#transpose(java.util.List))([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") lists)`Transposes the given lists. \| \| `<T>` \| `public static [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<T>` \| `[union](#union(Iterable))([Iterable](https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html "Iterable")<T> iterables)`Returns an ordered set of all the unique items found in the provided argument iterables. \| \| `<T>` \| `public static [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<T>` \| `[union](#union(List))([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Iterable](https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html "Iterable")<T>> iterables)`Returns an ordered set of all the unique items found in the provided argument iterables. \| \| `<T>` \| `public static [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<T>` \| `[union](#union(Comparator,%20Iterable))([Comparator](https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html "Comparator")<T> comparator, [Iterable](https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html "Iterable")<T> iterables)`Returns an ordered set of all the unique items found in the provided argument iterables using the provided comparator to compare items. \| \| `<T>` \| `public static [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<T>` \| `[union](#union(List,%20Comparator))([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Iterable](https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html "Iterable")<T>> iterables, [Comparator](https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html "Comparator")<T> comparator)`Returns an ordered set of all the unique items found in the provided argument iterables using the provided comparator to compare items. \| \| `<T>` \| `public static [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<T>` \| `[union](#union(groovy.lang.Closure,%20Iterable))([Closure](../lang/closure) condition, [Iterable](https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html "Iterable")<T> iterables)`Returns an ordered set of all the unique items found in the provided argument iterables using the provided closure to compare items. \| \| `<T>` \| `public static [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<T>` \| `[union](#union(List,%20groovy.lang.Closure))([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Iterable](https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html "Iterable")<T>> iterables, [Closure](../lang/closure) condition)`Returns an ordered set of all the unique items found in the provided argument iterables using the provided closure to compare items. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### public static [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") combinations([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] collections) Finds all combinations of items from the given collections. Parameters: `collections` - the given collections Returns: a List of the combinations found See Also: [combinations(Iterable)](#combinations(java.lang.Iterable)) ### public static [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") combinations([Iterable](https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html "Iterable") collections) Finds all combinations of items from the given Iterable aggregate of collections. So, `combinations([[true, false], [true, false]])` is `[[true, true], [false, true], [true, false], [false, false]]` and `combinations([['a', 'b'],[1, 2, 3]])` is `[['a', 1], ['b', 1], ['a', 2], ['b', 2], ['a', 3], ['b', 3]]`. If a non-collection item is given, it is treated as a singleton collection, i.e. `combinations([[1, 2], 'x'])` is `[[1, 'x'], [2, 'x']]`. If an empty collection is found within the given collections, the result will be an empty list. Parameters: `collections` - the Iterable of given collections Returns: a List of the combinations found Since: 2.2.0 ### <T> public static [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<T>> inits([Iterable](https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html "Iterable")<T> collections) ### <T> public static T max(T[] items) Selects the maximum value found in an array of items, so max([2, 4, 6] as Object[]) == 6. Parameters: `items` - an array of items Returns: the maximum value ### <T> public static T max([Iterable](https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html "Iterable")<T> items) Selects the maximum value found in an Iterable. Parameters: `items` - a Collection Returns: the maximum value Since: 2.2.0 ### <T> public static T min(T[] items) Selects the minimum value found in an array of items, so min([2, 4, 6] as Object[]) == 2. Parameters: `items` - an array of items Returns: the minimum value ### <T> public static T min([Iterable](https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html "Iterable")<T> items) Selects the minimum value found in an Iterable of items. Parameters: `items` - an Iterable Returns: the minimum value Since: 2.2.0 ### <T> public static [Set](https://docs.oracle.com/javase/8/docs/api/java/util/Set.html "Set")<[List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<T>> subsequences([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<T> items) Finds all non-null subsequences of a list. E.g. `subsequences([1, 2, 3])` would be: [[1, 2, 3], [1, 3], [2, 3], [1, 2], [1], [2], [3]] Parameters: `items` - the List of items Returns: the subsequences from items ### public static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") sum([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] items) Sums all the items from an array of items. Parameters: `items` - an array of items Returns: the sum of the items ### public static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") sum([Iterable](https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html "Iterable")<?> items) Sums all the given items. Parameters: `items` - an Iterable of items Returns: the sum of the item Since: 2.2.0 ### <T> public static [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<T>> tails([Iterable](https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html "Iterable")<T> collections) ### public static [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") transpose([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] lists) Transposes an array of lists. Parameters: `lists` - the given lists Returns: a List of the transposed lists See Also: [transpose(List)](#transpose(java.util.List)) ### public static [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") transpose([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") lists) Transposes the given lists. So, `transpose([['a', 'b'], [1, 2]])` is `[['a', 1], ['b', 2]]` and `transpose([['a', 'b', 'c']])` is `[['a'], ['b'], ['c']]`. Parameters: `lists` - the given lists Returns: a List of the transposed lists ### <T> public static [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<T> union([Iterable](https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html "Iterable")<T> iterables) Returns an ordered set of all the unique items found in the provided argument iterables. ``` assert GroovyCollections.union([1, 2], [2, 3], [1, 4]) == [1, 2, 3, 4] ``` Parameters: `iterables` - the sources of items Returns: the ordered list of unique values found Since: 4.0.0 ### <T> public static [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<T> union([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Iterable](https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html "Iterable")<T>> iterables) Returns an ordered set of all the unique items found in the provided argument iterables. ``` assert GroovyCollections.union([[1, 2], [2, 3], [1, 4]]) == [1, 2, 3, 4] ``` Parameters: `iterables` - the list of source items Returns: the ordered list of unique values found Since: 4.0.0 ### <T> public static [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<T> union([Comparator](https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html "Comparator")<T> comparator, [Iterable](https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html "Iterable")<T> iterables) Returns an ordered set of all the unique items found in the provided argument iterables using the provided comparator to compare items. ``` assert GroovyCollections.union(n -> n.abs(), [1, 2, 5], [-3, -4, -5], [4, 6]) == [1, 2, 5, -3, -4, 6] assert GroovyCollections.union(n -> n.trunc(), [1.1, 2.2], [2.5, 3.3], [3.9, 4.1]) == [1.1, 2.2, 3.3, 4.1] assert GroovyCollections.union(w -> w.toUpperCase(), ['a', 'A'], ['B', 'a', 'c', 'b']) == ['a', 'B', 'c'] ``` Parameters: `comparator` - a Comparator `iterables` - the sources of items Returns: the ordered list of unique values found Since: 4.0.0 ### <T> public static [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<T> union([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Iterable](https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html "Iterable")<T>> iterables, [Comparator](https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html "Comparator")<T> comparator) Returns an ordered set of all the unique items found in the provided argument iterables using the provided comparator to compare items. ``` assert GroovyCollections.union([[1, 2, 5], [-3, -4, -5], [4, 6]], n -> n.abs()) == [1, 2, 5, -3, -4, 6] assert GroovyCollections.union([[1.1, 2.2], [2.5, 3.3], [3.9, 4.1]], n -> n.trunc()) == [1.1, 2.2, 3.3, 4.1] assert GroovyCollections.union([['a', 'A'], ['B', 'a', 'c', 'b']], w -> w.toUpperCase()) == ['a', 'B', 'c'] ``` Parameters: `iterables` - the list of source items `comparator` - a Comparator Returns: the ordered list of unique values found Since: 4.0.0 ### <T> public static [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<T> union(@[ClosureParams](../transform/stc/closureparams "ClosureParams")(value= FromString.class, options={"T","T,T"}) [Closure](../lang/closure) condition, [Iterable](https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html "Iterable")<T> iterables) Returns an ordered set of all the unique items found in the provided argument iterables using the provided closure to compare items. ``` def abs = { n -> n.abs() } assert GroovyCollections.union(abs, [1, 2, 5], [-3, -4, -5], [4, 6]) == [1, 2, 5, -3, -4, 6] ``` Parameters: `condition` - a Closure used to determine unique items `iterables` - the sources of items Returns: the ordered list of unique values found Since: 4.0.0 ### <T> public static [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<T> union([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Iterable](https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html "Iterable")<T>> iterables, @[ClosureParams](../transform/stc/closureparams "ClosureParams")(value= FromString.class, options={"T","T,T"}) [Closure](../lang/closure) condition) Returns an ordered set of all the unique items found in the provided argument iterables using the provided closure to compare items. ``` assert GroovyCollections.union([[1, 2, 5], [-3, -4, -5], [4, 6]]){ n -> n.abs() } == [1, 2, 5, -3, -4, 6] ``` Parameters: `iterables` - the list of source items `condition` - a Closure used to determine unique items Returns: the ordered list of unique values found Since: 4.0.0	programming_docs
groovy [Groovy] Class FileNameByRegexFinder [Groovy] Class FileNameByRegexFinder ==================================== * groovy.util.FileNameByRegexFinder All Implemented Interfaces and Traits: [IFileNameFinder](ifilenamefinder "IFileNameFinder") ``` class FileNameByRegexFinder extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") implements [IFileNameFinder](ifilenamefinder "IFileNameFinder") ``` Find files according to a base directory and an includes and excludes pattern. The include and exclude patterns conform to regex conventions. Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[FileNameByRegexFinder](#FileNameByRegexFinder())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>` \| `[getFileNames](#getFileNames(java.lang.String,%20java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") basedir, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") pattern)` \| \| \| `[List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>` \| `[getFileNames](#getFileNames(java.lang.String,%20java.lang.String,%20java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") basedir, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") pattern, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") excludesPattern)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### FileNameByRegexFinder() Method Detail ------------- ### [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> getFileNames([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") basedir, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") pattern) ### [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> getFileNames([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") basedir, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") pattern, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") excludesPattern) groovy [Java] Class ObservableList.MultiElementAddedEvent [Java] Class ObservableList.MultiElementAddedEvent ================================================== * groovy.util.ObservableList.MultiElementAddedEvent ``` public static class ObservableList.MultiElementAddedEvent extends [ElementEvent](../../elementevent) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[MultiElementAddedEvent](#MultiElementAddedEvent(java.lang.Object,%20int,%20java.util.List))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") source, int index, [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") values)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")` \| `[getValues](#getValues())()` \| Constructor Detail ------------------ ### public MultiElementAddedEvent([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") source, int index, [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") values) Method Detail ------------- ### public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") getValues() groovy [Java] Class ClosureComparator<T> [Java] Class ClosureComparator<T> ================================= * groovy.util.ClosureComparator All Implemented Interfaces and Traits: [Comparator](https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html "Comparator"), [Serializable](https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html "Serializable") ``` public class ClosureComparator<T> extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") implements [Comparator](https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html "Comparator"), [Serializable](https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html "Serializable") ``` A Comparator which uses a closure to compare 2 values being equal Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[ClosureComparator](#ClosureComparator(groovy.lang.Closure))([Closure](../lang/closure) closure)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public int` \| `[compare](#compare(T,%20T))(T object1, T object2)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public ClosureComparator([Closure](../lang/closure) closure) Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public int compare(T object1, T object2) groovy [Java] Class Expando [Java] Class Expando ==================== * groovy.util.Expando ``` public class Expando extends [GroovyObjectSupport](../lang/groovyobjectsupport) ``` Represents a dynamically expandable bean. Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[Expando](#Expando())()` \| \| `[Expando](#Expando(java.util.Map))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") expandoProperties)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `protected [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")` \| `[createMap](#createMap())()`Factory method to create a new Map used to store the expando properties map \| \| \| `public boolean` \| `[equals](#equals(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") obj)`This allows equals to be overridden by a closure field method attached to the expando object. \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")` \| `[getMetaPropertyValues](#getMetaPropertyValues())()` \| \| \| `public [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")` \| `[getProperties](#getProperties())()` Returns: the dynamically expanded properties \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getProperty](#getProperty(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") property)` \| \| \| `public int` \| `[hashCode](#hashCode())()`This allows hashCode to be overridden by a closure field method attached to the expando object. \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[invokeMethod](#invokeMethod(java.lang.String,%20java.lang.Object))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args)` \| \| \| `public void` \| `[setProperty](#setProperty(java.lang.String,%20java.lang.Object))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") property, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newValue)` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[toString](#toString())()`This allows toString to be overridden by a closure field method attached to the expando object. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [GroovyObjectSupport](../lang/groovyobjectsupport)` \| `[getMetaClass](../lang/groovyobjectsupport#getMetaClass()), [setMetaClass](../lang/groovyobjectsupport#setMetaClass(groovy.lang.MetaClass))` \| Constructor Detail ------------------ ### public Expando() ### public Expando([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") expandoProperties) Method Detail ------------- ### protected [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") createMap() Factory method to create a new Map used to store the expando properties map Returns: a newly created Map implementation ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean equals([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") obj) This allows equals to be overridden by a closure field method attached to the expando object. See Also: [Object.equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "Object.equals") ### public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") getMetaPropertyValues() ### public [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") getProperties() Returns: the dynamically expanded properties ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getProperty([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") property) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public int hashCode() This allows hashCode to be overridden by a closure field method attached to the expando object. See Also: [Object.hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "Object.hashCode") ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") invokeMethod([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void setProperty([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") property, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newValue) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") toString() This allows toString to be overridden by a closure field method attached to the expando object. See Also: [Object.toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "Object.toString") groovy [Java] Class AbstractFactory [Java] Class AbstractFactory ============================ * groovy.util.AbstractFactory All Implemented Interfaces and Traits: [Factory](factory) ``` public abstract class AbstractFactory extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") implements [Factory](factory) ``` Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public boolean` \| `[isHandlesNodeChildren](#isHandlesNodeChildren())()` \| \| \| `public boolean` \| `[isLeaf](#isLeaf())()` \| \| \| `public void` \| `[onFactoryRegistration](#onFactoryRegistration(groovy.util.FactoryBuilderSupport,%20java.lang.String,%20java.lang.String))([FactoryBuilderSupport](factorybuildersupport) builder, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") registeredName, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") group)` \| \| \| `public boolean` \| `[onHandleNodeAttributes](#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| \| \| `public boolean` \| `[onNodeChildren](#onNodeChildren(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20groovy.lang.Closure))([FactoryBuilderSupport](factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Closure](../lang/closure) childContent)` \| \| \| `public void` \| `[onNodeCompleted](#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))([FactoryBuilderSupport](factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node)` \| \| \| `public void` \| `[setChild](#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))([FactoryBuilderSupport](factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child)` \| \| \| `public void` \| `[setParent](#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))([FactoryBuilderSupport](factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean isHandlesNodeChildren() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean isLeaf() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void onFactoryRegistration([FactoryBuilderSupport](factorybuildersupport) builder, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") registeredName, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") group) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean onHandleNodeAttributes([FactoryBuilderSupport](factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean onNodeChildren([FactoryBuilderSupport](factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Closure](../lang/closure) childContent) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void onNodeCompleted([FactoryBuilderSupport](factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void setChild([FactoryBuilderSupport](factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void setParent([FactoryBuilderSupport](factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child)	programming_docs
groovy [Java] Class ObservableSet.MultiElementAddedEvent [Java] Class ObservableSet.MultiElementAddedEvent ================================================= * groovy.util.ObservableSet.MultiElementAddedEvent ``` public static class ObservableSet.MultiElementAddedEvent extends [ElementEvent](../../elementevent) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[MultiElementAddedEvent](#MultiElementAddedEvent(java.lang.Object,%20java.util.List))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") source, [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") values)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")` \| `[getValues](#getValues())()` \| Constructor Detail ------------------ ### public MultiElementAddedEvent([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") source, [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") values) Method Detail ------------- ### public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") getValues() groovy [Java] Class NodePrinter [Java] Class NodePrinter ======================== * groovy.util.NodePrinter ``` public class NodePrinter extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` A helper class for creating nested trees of data Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `protected [IndentPrinter](indentprinter)` \| `[out](#out)` \| \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[NodePrinter](#NodePrinter())()` \| \| `[NodePrinter](#NodePrinter(java.io.PrintWriter))([PrintWriter](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html "PrintWriter") out)` \| \| `[NodePrinter](#NodePrinter(groovy.util.IndentPrinter))([IndentPrinter](indentprinter) out)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public void` \| `[print](#print(groovy.util.Node))([Node](node) node)` \| \| \| `protected void` \| `[printAttributes](#printAttributes(java.util.Map))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| \| \| `protected void` \| `[printList](#printList(java.util.List))([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") list)` \| \| \| `protected void` \| `[printName](#printName(groovy.util.Node))([Node](node) node)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Field Detail ------------ ### protected final [IndentPrinter](indentprinter) out Constructor Detail ------------------ ### public NodePrinter() ### public NodePrinter([PrintWriter](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html "PrintWriter") out) ### public NodePrinter([IndentPrinter](indentprinter) out) Method Detail ------------- ### public void print([Node](node) node) ### protected void printAttributes([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) ### protected void printList([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") list) ### protected void printName([Node](node) node) groovy [Java] Class ScriptException [Java] Class ScriptException ============================ * groovy.util.ScriptException ``` public class ScriptException extends [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html "Exception") ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[ScriptException](#ScriptException())()` \| \| `[ScriptException](#ScriptException(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message)` Parameters: message \| \| `[ScriptException](#ScriptException(java.lang.String,%20java.lang.Throwable))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message, [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html "Throwable") cause)` Parameters: message \| \| `[ScriptException](#ScriptException(java.lang.Throwable))([Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html "Throwable") cause)` Parameters: cause \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html "Exception")` \| `[printStackTrace](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html#printStackTrace() "printStackTrace"), [printStackTrace](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html#printStackTrace(java.io.PrintStream) "printStackTrace"), [printStackTrace](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html#printStackTrace(java.io.PrintWriter) "printStackTrace"), [fillInStackTrace](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html#fillInStackTrace() "fillInStackTrace"), [getCause](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html#getCause() "getCause"), [initCause](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html#initCause(java.lang.Throwable) "initCause"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html#toString() "toString"), [getMessage](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html#getMessage() "getMessage"), [getSuppressed](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html#getSuppressed() "getSuppressed"), [getLocalizedMessage](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html#getLocalizedMessage() "getLocalizedMessage"), [getStackTrace](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html#getStackTrace() "getStackTrace"), [setStackTrace](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html#setStackTrace(%5BLjava.lang.StackTraceElement;) "setStackTrace"), [addSuppressed](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html#addSuppressed(java.lang.Throwable) "addSuppressed"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html#equals(java.lang.Object) "equals"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public ScriptException() ### public ScriptException([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message) Parameters: message ### public ScriptException([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message, [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html "Throwable") cause) Parameters: message cause ### public ScriptException([Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html "Throwable") cause) Parameters: cause groovy [Java] Interface Factory [Java] Interface Factory ======================== ``` public interface Factory ``` Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public boolean` \| `[isHandlesNodeChildren](#isHandlesNodeChildren())()`Does this factory "Own" its child closure. \| \| \| `public boolean` \| `[isLeaf](#isLeaf())()` Returns: true if no child closures should be processed \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` Parameters: `builder` - the FactoryBuilder \| \| \| `public void` \| `[onFactoryRegistration](#onFactoryRegistration(groovy.util.FactoryBuilderSupport,%20java.lang.String,%20java.lang.String))([FactoryBuilderSupport](factorybuildersupport) builder, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") registeredName, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") registeredGroupName)`Called when a factory is registered to a builder \| \| \| `public boolean` \| `[onHandleNodeAttributes](#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` Parameters: `builder` - the FactoryBuilder \| \| \| `public boolean` \| `[onNodeChildren](#onNodeChildren(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20groovy.lang.Closure))([FactoryBuilderSupport](factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Closure](../lang/closure) childContent)`Only called if it isLeaf is false and isHandlesNodeChildren is true \| \| \| `public void` \| `[onNodeCompleted](#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))([FactoryBuilderSupport](factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node)` Parameters: `builder` - the FactoryBuilder \| \| \| `public void` \| `[setChild](#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))([FactoryBuilderSupport](factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child)` \| \| \| `public void` \| `[setParent](#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))([FactoryBuilderSupport](factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child)` \| Method Detail ------------- ### public boolean isHandlesNodeChildren() Does this factory "Own" its child closure. Returns: true if the factory should have onContentClosure() called, false if the builder should handle it ### public boolean isLeaf() Returns: true if no child closures should be processed ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) throws: InstantiationException if attempting to instantiate an interface or abstract class throws: IllegalAccessException if the instance can't be created due to a security violation Parameters: `builder` - the FactoryBuilder `name` - the name of the node being built `value` - the 'value' argument in the build node `attributes` - the attributes of the build arg Returns: the object created for the builder ### public void onFactoryRegistration([FactoryBuilderSupport](factorybuildersupport) builder, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") registeredName, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") registeredGroupName) Called when a factory is registered to a builder Parameters: `builder` - the build the factory has been registered to `registeredName` - the name the factory has been registered under ### public boolean onHandleNodeAttributes([FactoryBuilderSupport](factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) Parameters: `builder` - the FactoryBuilder `node` - the node (returned from newINstance) to consider the attributes for `attributes` - the attributes, a mutable set Returns: true if the factory builder should use standard bean property matching for the remaining attributes ### public boolean onNodeChildren([FactoryBuilderSupport](factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Closure](../lang/closure) childContent) Only called if it isLeaf is false and isHandlesNodeChildren is true Parameters: `builder` - the FactoryBuilder `node` - the node (returned from newINstance) to consider the attributes for `childContent` - the child content closure of the builder Returns: true if the factory builder should apply default node processing to the content child ### public void onNodeCompleted([FactoryBuilderSupport](factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node) Parameters: `builder` - the FactoryBuilder `parent` - the parent node (null if 'root') `node` - the node just completed ### public void setChild([FactoryBuilderSupport](factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child) ### public void setParent([FactoryBuilderSupport](factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child) groovy [Java] Class ObservableMap.PropertyUpdatedEvent [Java] Class ObservableMap.PropertyUpdatedEvent =============================================== * groovy.util.ObservableMap.PropertyUpdatedEvent ``` public static class ObservableMap.PropertyUpdatedEvent extends [PropertyEvent](../../propertyevent) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[PropertyUpdatedEvent](#PropertyUpdatedEvent(java.lang.Object,%20java.lang.String,%20java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") source, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") propertyName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") oldValue, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newValue)` \| Constructor Detail ------------------ ### public PropertyUpdatedEvent([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") source, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") propertyName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") oldValue, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newValue) groovy [Java] Class ProxyGenerator [Java] Class ProxyGenerator =========================== * groovy.util.ProxyGenerator ``` public class ProxyGenerator extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Classes to generate 'Proxy' objects which implement interfaces, maps of closures and/or extend classes/delegates. Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `static [ProxyGenerator](proxygenerator)` \| `[INSTANCE](#INSTANCE)` \| \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public boolean` \| `[getDebug](#getDebug())()` \| \| \| `public boolean` \| `[getEmptyMethods](#getEmptyMethods())()` \| \| \| `public [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html "ClassLoader")` \| `[getOverride](#getOverride())()` \| \| \| `public [GroovyObject](../lang/groovyobject)` \| `[instantiateAggregate](#instantiateAggregate(List))([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")> interfaces)` \| \| \| `public [GroovyObject](../lang/groovyobject)` \| `[instantiateAggregate](#instantiateAggregate(java.util.Map,%20List))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") closureMap, [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")> interfaces)` \| \| \| `public [GroovyObject](../lang/groovyobject)` \| `[instantiateAggregate](#instantiateAggregate(java.util.Map,%20List,%20java.lang.Class))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") closureMap, [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")> interfaces, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") clazz)` \| \| \| `public [GroovyObject](../lang/groovyobject)` \| `[instantiateAggregate](#instantiateAggregate(java.util.Map,%20List,%20java.lang.Class,%20java.lang.Object))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") closureMap, [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")> interfaces, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") clazz, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] constructorArgs)` \| \| \| `public [GroovyObject](../lang/groovyobject)` \| `[instantiateAggregateFromBaseClass](#instantiateAggregateFromBaseClass(java.lang.Class))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") clazz)` \| \| \| `public [GroovyObject](../lang/groovyobject)` \| `[instantiateAggregateFromBaseClass](#instantiateAggregateFromBaseClass(java.util.Map,%20java.lang.Class))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") map, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") clazz)` \| \| \| `public [GroovyObject](../lang/groovyobject)` \| `[instantiateAggregateFromBaseClass](#instantiateAggregateFromBaseClass(groovy.lang.Closure,%20java.lang.Class))([Closure](../lang/closure) cl, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") clazz)` \| \| \| `public [GroovyObject](../lang/groovyobject)` \| `[instantiateAggregateFromBaseClass](#instantiateAggregateFromBaseClass(java.lang.Class,%20java.lang.Object))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") clazz, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] constructorArgs)` \| \| \| `public [GroovyObject](../lang/groovyobject)` \| `[instantiateAggregateFromBaseClass](#instantiateAggregateFromBaseClass(java.util.Map,%20java.lang.Class,%20java.lang.Object))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") map, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") clazz, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] constructorArgs)` \| \| \| `public [GroovyObject](../lang/groovyobject)` \| `[instantiateAggregateFromInterface](#instantiateAggregateFromInterface(java.lang.Class))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") clazz)` \| \| \| `public [GroovyObject](../lang/groovyobject)` \| `[instantiateAggregateFromInterface](#instantiateAggregateFromInterface(java.util.Map,%20java.lang.Class))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") map, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") clazz)` \| \| \| `public [GroovyObject](../lang/groovyobject)` \| `[instantiateDelegate](#instantiateDelegate(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") delegate)` \| \| \| `public [GroovyObject](../lang/groovyobject)` \| `[instantiateDelegate](#instantiateDelegate(List,%20java.lang.Object))([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")> interfaces, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") delegate)` \| \| \| `public [GroovyObject](../lang/groovyobject)` \| `[instantiateDelegate](#instantiateDelegate(java.util.Map,%20List,%20java.lang.Object))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") closureMap, [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")> interfaces, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") delegate)` \| \| \| `public [GroovyObject](../lang/groovyobject)` \| `[instantiateDelegateWithBaseClass](#instantiateDelegateWithBaseClass(java.util.Map,%20List,%20java.lang.Object))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") closureMap, [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")> interfaces, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") delegate)` \| \| \| `public [GroovyObject](../lang/groovyobject)` \| `[instantiateDelegateWithBaseClass](#instantiateDelegateWithBaseClass(java.util.Map,%20List,%20java.lang.Object,%20java.lang.Class))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") closureMap, [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")> interfaces, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") delegate, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") baseClass)` \| \| \| `public [GroovyObject](../lang/groovyobject)` \| `[instantiateDelegateWithBaseClass](#instantiateDelegateWithBaseClass(java.util.Map,%20List,%20java.lang.Object,%20java.lang.Class,%20java.lang.String))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") closureMap, [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")> interfaces, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") delegate, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") baseClass, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name)`Creates a proxy with a delegate object. \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[invokeStaticMethod](#invokeStaticMethod(java.lang.Object,%20java.lang.String,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] arguments)` \| \| \| `public void` \| `[setDebug](#setDebug(boolean))(boolean debug)`Instructs `ProxyGenerator` to dump generated Groovy source code to standard output during construction. \| \| \| `public void` \| `[setEmptyMethods](#setEmptyMethods(boolean))(boolean emptyMethods)`Changes generated methods to have empty implementations. \| \| \| `public void` \| `[setOverride](#setOverride(java.lang.ClassLoader))([ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html "ClassLoader") override)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Field Detail ------------ ### public static final [ProxyGenerator](proxygenerator) INSTANCE Method Detail ------------- ### public boolean getDebug() ### public boolean getEmptyMethods() ### public [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html "ClassLoader") getOverride() ### public [GroovyObject](../lang/groovyobject) instantiateAggregate([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")> interfaces) ### public [GroovyObject](../lang/groovyobject) instantiateAggregate([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") closureMap, [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")> interfaces) ### public [GroovyObject](../lang/groovyobject) instantiateAggregate([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") closureMap, [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")> interfaces, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") clazz) ### @[SuppressWarnings](https://docs.oracle.com/javase/8/docs/api/java/lang/SuppressWarnings.html "SuppressWarnings")("unchecked") public [GroovyObject](../lang/groovyobject) instantiateAggregate([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") closureMap, [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")> interfaces, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") clazz, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] constructorArgs) ### public [GroovyObject](../lang/groovyobject) instantiateAggregateFromBaseClass([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") clazz) ### public [GroovyObject](../lang/groovyobject) instantiateAggregateFromBaseClass([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") map, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") clazz) ### public [GroovyObject](../lang/groovyobject) instantiateAggregateFromBaseClass([Closure](../lang/closure) cl, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") clazz) ### public [GroovyObject](../lang/groovyobject) instantiateAggregateFromBaseClass([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") clazz, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] constructorArgs) ### public [GroovyObject](../lang/groovyobject) instantiateAggregateFromBaseClass([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") map, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") clazz, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] constructorArgs) ### public [GroovyObject](../lang/groovyobject) instantiateAggregateFromInterface([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") clazz) ### public [GroovyObject](../lang/groovyobject) instantiateAggregateFromInterface([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") map, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") clazz) ### public [GroovyObject](../lang/groovyobject) instantiateDelegate([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") delegate) ### public [GroovyObject](../lang/groovyobject) instantiateDelegate([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")> interfaces, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") delegate) ### public [GroovyObject](../lang/groovyobject) instantiateDelegate([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") closureMap, [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")> interfaces, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") delegate) ### public [GroovyObject](../lang/groovyobject) instantiateDelegateWithBaseClass([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") closureMap, [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")> interfaces, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") delegate) ### public [GroovyObject](../lang/groovyobject) instantiateDelegateWithBaseClass([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") closureMap, [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")> interfaces, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") delegate, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") baseClass) ### @[SuppressWarnings](https://docs.oracle.com/javase/8/docs/api/java/lang/SuppressWarnings.html "SuppressWarnings")("unchecked") public [GroovyObject](../lang/groovyobject) instantiateDelegateWithBaseClass([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") closureMap, [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")> interfaces, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") delegate, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") baseClass, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name) Creates a proxy with a delegate object. Parameters: `closureMap` - the closure for methods not handled by the delegate `interfaces` - interfaces to be implemented `delegate` - the delegate object `baseClass` - the base class `name` - the name of the proxy, unused, but kept for compatibility with previous versions of Groovy. Returns: a proxy object implementing the specified interfaces, and delegating to the provided object ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") invokeStaticMethod([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] arguments) ### public void setDebug(boolean debug) Instructs `ProxyGenerator` to dump generated Groovy source code to standard output during construction. This is useful for debugging purposes but should be turned off in production. Parameters: `debug` - true if you want generated source to be printed ### public void setEmptyMethods(boolean emptyMethods) Changes generated methods to have empty implementations. Methods in generated aggregates not supplied in a closures map or base class are given 'default' implementations. The implementation will normally throw an `UnsupportedOperationException` but setting this boolean will leave it empty. Parameters: `emptyMethods` - true if you want generated methods to be empty ### public void setOverride([ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html "ClassLoader") override)	programming_docs
groovy [Java] Class ObservableMap.MultiPropertyEvent [Java] Class ObservableMap.MultiPropertyEvent ============================================= * groovy.util.ObservableMap.MultiPropertyEvent ``` public static class ObservableMap.MultiPropertyEvent extends [PropertyEvent](../../propertyevent) ``` Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[MULTI\_PROPERTY](#MULTI_PROPERTY)` \| \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[MultiPropertyEvent](#MultiPropertyEvent(java.lang.Object,%20PropertyEvent))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") source, [PropertyEvent](../../propertyevent)[] events)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [PropertyEvent](../../propertyevent)[]` \| `[getEvents](#getEvents())()` \| Field Detail ------------ ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") MULTI\_PROPERTY Constructor Detail ------------------ ### public MultiPropertyEvent([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") source, [PropertyEvent](../../propertyevent)[] events) Method Detail ------------- ### public [PropertyEvent](../../propertyevent)[] getEvents() groovy [Java] Interface IFileNameFinder [Java] Interface IFileNameFinder ================================ ``` public interface IFileNameFinder ``` Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>` \| `[getFileNames](#getFileNames(java.lang.String,%20java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") basedir, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") pattern)` \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>` \| `[getFileNames](#getFileNames(java.lang.String,%20java.lang.String,%20java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") basedir, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") pattern, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") excludesPattern)` \| Method Detail ------------- ### public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> getFileNames([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") basedir, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") pattern) ### public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> getFileNames([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") basedir, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") pattern, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") excludesPattern) groovy [Java] Class ObservableMap [Java] Class ObservableMap ========================== * groovy.util.ObservableMap All Implemented Interfaces and Traits: [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") ``` public class ObservableMap extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") implements [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") ``` Map decorator that will trigger PropertyChangeEvents when a value changes. An optional Closure may be specified and will work as a filter, if it returns true the property will trigger an event (if the value indeed changed), otherwise it won't. The Closure may receive 1 or 2 parameters, the single one being the value, the other one both the key and value, for example: ``` // skip all properties whose value is a closure def map = new ObservableMap( {!(it instanceof Closure)} ) // skip all properties whose name matches a regex def map = new ObservableMap( { name, value -> !(name =~ /[A-Z+]/) } ) ``` The current implementation will trigger specialized events in the following scenarios, you need not register a different listener as those events extend from PropertyChangeEvent * ObservableMap.PropertyAddedEvent - a new property is added to the map * ObservableMap.PropertyRemovedEvent - a property is removed from the map * ObservableMap.PropertyUpdatedEvent - a property changes value (same as regular PropertyChangeEvent) * ObservableMap.PropertyClearedEvent - all properties have been removed from the map * ObservableMap.MultiPropertyEvent - triggered by calling map.putAll(), contains Added\|Updated events Bound properties * content - read-only. * size - read-only. Nested Class Summary -------------------- Nested classes \| Modifiers \| Name \| Description \| \| `enum` \| `[ObservableMap.ChangeType](observablemap.changetype)` \| \| \| `static class` \| `[ObservableMap.MultiPropertyEvent](observablemap.multipropertyevent)` \| \| \| `static class` \| `[ObservableMap.PropertyAddedEvent](observablemap.propertyaddedevent)` \| \| \| `static class` \| `[ObservableMap.PropertyClearedEvent](observablemap.propertyclearedevent)` \| \| \| `static class` \| `[ObservableMap.PropertyEvent](observablemap.propertyevent)` \| \| \| `static class` \| `[ObservableMap.PropertyRemovedEvent](observablemap.propertyremovedevent)` \| \| \| `static class` \| `[ObservableMap.PropertyUpdatedEvent](observablemap.propertyupdatedevent)` \| \| Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[CLEARED\_PROPERTY](#CLEARED_PROPERTY)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[CONTENT\_PROPERTY](#CONTENT_PROPERTY)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[SIZE\_PROPERTY](#SIZE_PROPERTY)` \| \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[ObservableMap](#ObservableMap())()` \| \| `[ObservableMap](#ObservableMap(groovy.lang.Closure))([Closure](../lang/closure) test)` \| \| `[ObservableMap](#ObservableMap(java.util.Map))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") delegate)` \| \| `[ObservableMap](#ObservableMap(java.util.Map,%20groovy.lang.Closure))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") delegate, [Closure](../lang/closure) test)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public void` \| `[addPropertyChangeListener](#addPropertyChangeListener(java.beans.PropertyChangeListener))([PropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html "PropertyChangeListener") listener)` \| \| \| `public void` \| `[addPropertyChangeListener](#addPropertyChangeListener(java.lang.String,%20java.beans.PropertyChangeListener))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") propertyName, [PropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html "PropertyChangeListener") listener)` \| \| \| `public void` \| `[clear](#clear())()` \| \| \| `public boolean` \| `[containsKey](#containsKey(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") key)` \| \| \| `public boolean` \| `[containsValue](#containsValue(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| \| \| `public [Set](https://docs.oracle.com/javase/8/docs/api/java/util/Set.html "Set")` \| `[entrySet](#entrySet())()` \| \| \| `public boolean` \| `[equals](#equals(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o)` \| \| \| `protected void` \| `[fireMultiPropertyEvent](#fireMultiPropertyEvent(List))([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<PropertyEvent> events)` \| \| \| `protected void` \| `[fireMultiPropertyEvent](#fireMultiPropertyEvent(PropertyEvent))([PropertyEvent](../../propertyevent)[] events)` \| \| \| `protected void` \| `[firePropertyAddedEvent](#firePropertyAddedEvent(java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") key, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| \| \| `protected void` \| `[firePropertyClearedEvent](#firePropertyClearedEvent(java.util.Map))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") values)` \| \| \| `protected void` \| `[firePropertyEvent](#firePropertyEvent(PropertyEvent))([PropertyEvent](../../propertyevent) event)` \| \| \| `protected void` \| `[firePropertyRemovedEvent](#firePropertyRemovedEvent(java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") key, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| \| \| `protected void` \| `[firePropertyUpdatedEvent](#firePropertyUpdatedEvent(java.lang.Object,%20java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") key, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") oldValue, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newValue)` \| \| \| `protected void` \| `[fireSizeChangedEvent](#fireSizeChangedEvent(int,%20int))(int oldValue, int newValue)` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[get](#get(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") key)` \| \| \| `public [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")` \| `[getContent](#getContent())()` \| \| \| `protected [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")` \| `[getMapDelegate](#getMapDelegate())()` \| \| \| `public [PropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html "PropertyChangeListener")[]` \| `[getPropertyChangeListeners](#getPropertyChangeListeners())()` \| \| \| `public [PropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html "PropertyChangeListener")[]` \| `[getPropertyChangeListeners](#getPropertyChangeListeners(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") propertyName)` \| \| \| `public int` \| `[getSize](#getSize())()` \| \| \| `protected [Closure](../lang/closure)` \| `[getTest](#getTest())()` \| \| \| `public boolean` \| `[hasListeners](#hasListeners(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") propertyName)` \| \| \| `public int` \| `[hashCode](#hashCode())()` \| \| \| `public boolean` \| `[isEmpty](#isEmpty())()` \| \| \| `public [Set](https://docs.oracle.com/javase/8/docs/api/java/util/Set.html "Set")` \| `[keySet](#keySet())()` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[put](#put(java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") key, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| \| \| `public void` \| `[putAll](#putAll(java.util.Map))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") map)` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[remove](#remove(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") key)` \| \| \| `public void` \| `[removePropertyChangeListener](#removePropertyChangeListener(java.beans.PropertyChangeListener))([PropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html "PropertyChangeListener") listener)` \| \| \| `public void` \| `[removePropertyChangeListener](#removePropertyChangeListener(java.lang.String,%20java.beans.PropertyChangeListener))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") propertyName, [PropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html "PropertyChangeListener") listener)` \| \| \| `public int` \| `[size](#size())()` \| \| \| `public [Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection")` \| `[values](#values())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Field Detail ------------ ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") CLEARED\_PROPERTY ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") CONTENT\_PROPERTY ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") SIZE\_PROPERTY Constructor Detail ------------------ ### public ObservableMap() ### public ObservableMap([Closure](../lang/closure) test) ### public ObservableMap([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") delegate) ### public ObservableMap([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") delegate, [Closure](../lang/closure) test) Method Detail ------------- ### public void addPropertyChangeListener([PropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html "PropertyChangeListener") listener) ### public void addPropertyChangeListener([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") propertyName, [PropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html "PropertyChangeListener") listener) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void clear() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean containsKey([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") key) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean containsValue([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Set](https://docs.oracle.com/javase/8/docs/api/java/util/Set.html "Set") entrySet() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean equals([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o) ### protected void fireMultiPropertyEvent([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<PropertyEvent> events) ### protected void fireMultiPropertyEvent([PropertyEvent](../../propertyevent)[] events) ### protected void firePropertyAddedEvent([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") key, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) ### protected void firePropertyClearedEvent([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") values) ### protected void firePropertyEvent([PropertyEvent](../../propertyevent) event) ### protected void firePropertyRemovedEvent([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") key, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) ### protected void firePropertyUpdatedEvent([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") key, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") oldValue, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newValue) ### protected void fireSizeChangedEvent(int oldValue, int newValue) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") get([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") key) ### public [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") getContent() ### protected [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") getMapDelegate() ### public [PropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html "PropertyChangeListener")[] getPropertyChangeListeners() ### public [PropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html "PropertyChangeListener")[] getPropertyChangeListeners([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") propertyName) ### public int getSize() ### protected [Closure](../lang/closure) getTest() ### public boolean hasListeners([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") propertyName) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public int hashCode() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean isEmpty() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Set](https://docs.oracle.com/javase/8/docs/api/java/util/Set.html "Set") keySet() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") put([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") key, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void putAll([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") map) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") remove([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") key) ### public void removePropertyChangeListener([PropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html "PropertyChangeListener") listener) ### public void removePropertyChangeListener([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") propertyName, [PropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html "PropertyChangeListener") listener) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public int size() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection") values()	programming_docs
groovy [Java] Class ObservableList.ElementClearedEvent [Java] Class ObservableList.ElementClearedEvent =============================================== * groovy.util.ObservableList.ElementClearedEvent ``` public static class ObservableList.ElementClearedEvent extends [ElementEvent](../../elementevent) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[ElementClearedEvent](#ElementClearedEvent(java.lang.Object,%20java.util.List))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") source, [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") values)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")` \| `[getValues](#getValues())()` \| Constructor Detail ------------------ ### public ElementClearedEvent([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") source, [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") values) Method Detail ------------- ### public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") getValues() groovy [Groovy] Class FileTreeBuilder [Groovy] Class FileTreeBuilder ============================== * groovy.util.FileTreeBuilder ``` @[CompileStatic](../transform/compilestatic "CompileStatic") class FileTreeBuilder extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` A builder dedicated at generating a file directory structure from a specification. For example, imagine that you want to create the following tree: ``` src/ \|--- main \| \|--- groovy \| \|--- Foo.groovy \|--- test \|--- groovy \|--- FooTest.groovy ``` Then you can create the structure using: ``` def tree = new FileTreeBuilder() tree.dir('src') { dir('main') { dir('groovy') { file('Foo.groovy', 'println "Hello"') } } dir('test') { dir('groovy') { file('FooTest.groovy', 'class FooTest extends GroovyTestCase {}') } } } ``` or with this shorthand syntax: ``` def tree = new FileTreeBuilder() tree.src { main { groovy { 'Foo.groovy'('println "Hello"') } } test { groovy { 'FooTest.groovy'('class FooTest extends GroovyTestCase {}') } } } ``` Since: 2.4.2 Properties Summary ------------------ Properties \| Type \| Name and description \| \| `[File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File")` \| `[baseDir](#baseDir)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[FileTreeBuilder](#FileTreeBuilder(java.io.File))([File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File") baseDir)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File")` \| `[call](#call(groovy.lang.Closure))([Closure](../lang/closure) spec)` \| \| \| `[File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File")` \| `[dir](#dir(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name)`Creates a new empty directory \| \| \| `[File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File")` \| `[dir](#dir(java.lang.String,%20groovy.lang.Closure))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Closure](../lang/closure) cl)`Creates a new directory and allows to specify a subdirectory structure using the closure as a specification \| \| \| `[File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File")` \| `[file](#file(java.lang.String,%20java.lang.CharSequence))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [CharSequence](https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html "CharSequence") contents)`Creates a file with the specified name and the text contents using the system default encoding. \| \| \| `[File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File")` \| `[file](#file(java.lang.String,%20byte%5B%5D))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, byte[] contents)`Creates a file with the specified name and the specified binary contents \| \| \| `[File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File")` \| `[file](#file(java.lang.String,%20java.io.File))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File") source)`Creates a file with the specified name and the contents from the source file (copy). \| \| \| `[File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File")` \| `[file](#file(java.lang.String,%20groovy.lang.Closure))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Closure](../lang/closure) spec)`Creates a new file in the current directory, whose contents is going to be generated in the closure. \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[methodMissing](#methodMissing(java.lang.String,%20java.lang.Object))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Property Detail --------------- ### [File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File") baseDir Constructor Detail ------------------ ### FileTreeBuilder([File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File") baseDir) Method Detail ------------- ### [File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File") call(@[DelegatesTo](../lang/delegatesto "DelegatesTo")(value: FileTreeBuilder, strategy: Closure.DELEGATE\_FIRST) [Closure](../lang/closure) spec) ### [File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File") dir([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name) Creates a new empty directory Parameters: `name` - the name of the directory to create Returns: the created directory ### [File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File") dir([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, @[DelegatesTo](../lang/delegatesto "DelegatesTo")(value: FileTreeBuilder, strategy: Closure.DELEGATE\_FIRST) [Closure](../lang/closure) cl) Creates a new directory and allows to specify a subdirectory structure using the closure as a specification Parameters: `name` - name of the directory to be created `cl` - specification of the subdirectory structure Returns: the created directory ### [File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File") file([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [CharSequence](https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html "CharSequence") contents) Creates a file with the specified name and the text contents using the system default encoding. Parameters: `name` - name of the file to be created `contents` - the contents of the file, written using the system default encoding Returns: the file being created ### [File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File") file([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, byte[] contents) Creates a file with the specified name and the specified binary contents Parameters: `name` - name of the file to be created `contents` - the contents of the file Returns: the file being created ### [File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File") file([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File") source) Creates a file with the specified name and the contents from the source file (copy). Parameters: `name` - name of the file to be created `contents` - the contents of the file Returns: the file being created ### [File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File") file([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, @[DelegatesTo](../lang/delegatesto "DelegatesTo")(value: File, strategy: Closure.DELEGATE\_FIRST) [Closure](../lang/closure) spec) Creates a new file in the current directory, whose contents is going to be generated in the closure. The delegate of the closure is the file being created. Parameters: `name` - name of the file to create `spec` - closure for generating the file contents Returns: the created file ### @[SuppressWarnings](https://docs.oracle.com/javase/8/docs/api/java/lang/SuppressWarnings.html "SuppressWarnings")(value: Instanceof) [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") methodMissing([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args) groovy [Java] Class PermutationGenerator<E> [Java] Class PermutationGenerator<E> ==================================== * groovy.util.PermutationGenerator All Implemented Interfaces and Traits: [Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html "Iterator") ``` public class PermutationGenerator<E> extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") implements [Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html "Iterator") ``` Systematically generate permutations. Adapted from Java Code by Michael Gilleland (released with no restrictions) using an algorithm described here: Kenneth H. Rosen, Discrete Mathematics and Its Applications, 2nd edition (NY: McGraw-Hill, 1991), pp. 282-284 Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[PermutationGenerator](#PermutationGenerator(Collection))([Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection")<E> items)`WARNING: Don't make n too large. \| \| `[PermutationGenerator](#PermutationGenerator(Iterable))([Iterable](https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html "Iterable")<E> items)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [BigInteger](https://docs.oracle.com/javase/8/docs/api/java/math/BigInteger.html "BigInteger")` \| `[getTotal](#getTotal())()` \| \| \| `public boolean` \| `[hasNext](#hasNext())()` \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<E>` \| `[next](#next())()`Generate next permutation (algorithm from Rosen p. 284) \| \| \| `public void` \| `[remove](#remove())()` \| \| \| `public void` \| `[reset](#reset())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public PermutationGenerator([Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection")<E> items) WARNING: Don't make n too large. Recall that the number of permutations is n! which can be very large, even when n is as small as 20 -- 20! = 2,432,902,008,176,640,000 and 21! is too big to fit into a Java long, which is why we use BigInteger instead. Parameters: `items` - the items to permute ### public PermutationGenerator([Iterable](https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html "Iterable")<E> items) Method Detail ------------- ### public [BigInteger](https://docs.oracle.com/javase/8/docs/api/java/math/BigInteger.html "BigInteger") getTotal() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean hasNext() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<E> next() Generate next permutation (algorithm from Rosen p. 284) Returns: the items permuted ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void remove() ### public void reset() groovy [Java] Class NodeList [Java] Class NodeList ===================== * groovy.util.NodeList ``` public class NodeList extends [ArrayList](https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html "ArrayList") ``` A List implementation which is returned by queries on a [Node](node "Node") which provides some XPath like helper methods for GPath. Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[NodeList](#NodeList())()` \| \| `[NodeList](#NodeList(java.util.Collection))([Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection") collection)` \| \| `[NodeList](#NodeList(int))(int size)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[clone](#clone())()`Creates a new NodeList containing the same elements as the original (but cloned in the case of Nodes). \| \| \| `public [NodeList](nodelist)` \| `[getAt](#getAt(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name)`Provides lookup of elements by non-namespaced name. \| \| \| `public [NodeList](nodelist)` \| `[getAt](#getAt(groovy.namespace.QName))([QName](../namespace/qname) name)`Provides lookup of elements by QName. \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getAttribute](#getAttribute(java.lang.Object,%20java.lang.String))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") attribute)` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getProperty](#getProperty(java.lang.Object,%20java.lang.String))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") property)` \| \| \| `public void` \| `[plus](#plus(groovy.lang.Closure))([Closure](../lang/closure) c)` \| \| \| `public [Node](node)` \| `[replaceNode](#replaceNode(groovy.lang.Closure))([Closure](../lang/closure) c)` \| \| \| `public void` \| `[setAttribute](#setAttribute(java.lang.Object,%20java.lang.String,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") attribute, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newValue)` \| \| \| `protected static void` \| `[setMetaClass](#setMetaClass(java.lang.Class,%20groovy.lang.MetaClass))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") nodelistClass, [MetaClass](../lang/metaclass) metaClass)` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[text](#text())()`Returns the text value of all of the elements in the collection. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [ArrayList](https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html "ArrayList")` \| `[add](https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#add(java.lang.Object) "add"), [add](https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#add(int,%20java.lang.Object) "add"), [remove](https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#remove(java.lang.Object) "remove"), [remove](https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#remove(int) "remove"), [get](https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#get(int) "get"), [equals](https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#equals(java.lang.Object) "equals"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#hashCode() "hashCode"), [clone](https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#clone() "clone"), [indexOf](https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#indexOf(java.lang.Object) "indexOf"), [clear](https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#clear() "clear"), [lastIndexOf](https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#lastIndexOf(java.lang.Object) "lastIndexOf"), [isEmpty](https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#isEmpty() "isEmpty"), [replaceAll](https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#replaceAll(java.util.function.UnaryOperator) "replaceAll"), [size](https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#size() "size"), [subList](https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#subList(int,%20int) "subList"), [toArray](https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#toArray(%5BLjava.lang.Object;) "toArray"), [toArray](https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#toArray() "toArray"), [iterator](https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#iterator() "iterator"), [contains](https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#contains(java.lang.Object) "contains"), [spliterator](https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#spliterator() "spliterator"), [addAll](https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#addAll(java.util.Collection) "addAll"), [addAll](https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#addAll(int,%20java.util.Collection) "addAll"), [set](https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#set(int,%20java.lang.Object) "set"), [forEach](https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#forEach(java.util.function.Consumer) "forEach"), [ensureCapacity](https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#ensureCapacity(int) "ensureCapacity"), [trimToSize](https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#trimToSize() "trimToSize"), [removeIf](https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#removeIf(java.util.function.Predicate) "removeIf"), [sort](https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#sort(java.util.Comparator) "sort"), [removeAll](https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#removeAll(java.util.Collection) "removeAll"), [retainAll](https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#retainAll(java.util.Collection) "retainAll"), [listIterator](https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#listIterator() "listIterator"), [listIterator](https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#listIterator(int) "listIterator"), [toString](https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#toString() "toString"), [containsAll](https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#containsAll(java.util.Collection) "containsAll"), [wait](https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#wait(long) "wait"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#notifyAll() "notifyAll"), [toArray](https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#toArray(java.util.function.IntFunction) "toArray"), [stream](https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#stream() "stream"), [parallelStream](https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#parallelStream() "parallelStream")` \| Constructor Detail ------------------ ### public NodeList() ### public NodeList([Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection") collection) ### public NodeList(int size) Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") clone() Creates a new NodeList containing the same elements as the original (but cloned in the case of Nodes). Returns: the clone ### public [NodeList](nodelist) getAt([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name) Provides lookup of elements by non-namespaced name. Parameters: `name` - the name or shortcut key for nodes of interest Returns: the nodes of interest which match name ### public [NodeList](nodelist) getAt([QName](../namespace/qname) name) Provides lookup of elements by QName. Parameters: `name` - the name or shortcut key for nodes of interest Returns: the nodes of interest which match name ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getAttribute([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") attribute) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getProperty([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") property) ### public void plus([Closure](../lang/closure) c) ### public [Node](node) replaceNode([Closure](../lang/closure) c) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void setAttribute([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") attribute, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newValue) ### protected static void setMetaClass([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") nodelistClass, [MetaClass](../lang/metaclass) metaClass) ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text() Returns the text value of all of the elements in the collection. Returns: the text value of all the elements in the collection or null	programming_docs
groovy [Java] Class ObservableList.MultiElementRemovedEvent [Java] Class ObservableList.MultiElementRemovedEvent ==================================================== * groovy.util.ObservableList.MultiElementRemovedEvent ``` public static class ObservableList.MultiElementRemovedEvent extends [ElementEvent](../../elementevent) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[MultiElementRemovedEvent](#MultiElementRemovedEvent(java.lang.Object,%20java.util.List))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") source, [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") values)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")` \| `[getValues](#getValues())()` \| Constructor Detail ------------------ ### public MultiElementRemovedEvent([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") source, [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") values) Method Detail ------------- ### public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") getValues() groovy [Java] Class ObservableList.ElementUpdatedEvent [Java] Class ObservableList.ElementUpdatedEvent =============================================== * groovy.util.ObservableList.ElementUpdatedEvent ``` public static class ObservableList.ElementUpdatedEvent extends [ElementEvent](../../elementevent) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[ElementUpdatedEvent](#ElementUpdatedEvent(java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20int))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") source, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") oldValue, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newValue, int index)` \| Constructor Detail ------------------ ### public ElementUpdatedEvent([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") source, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") oldValue, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newValue, int index) groovy [Java] Interface ObjectGraphBuilder.ClassNameResolver [Java] Interface ObjectGraphBuilder.ClassNameResolver ===================================================== ``` public interface ObjectGraphBuilder.ClassNameResolver ``` Strategy for resolving a classname. Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[resolveClassname](#resolveClassname(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") classname)` Parameters: `classname` - the node name as written on the building code \| Method Detail ------------- ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") resolveClassname([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") classname) Parameters: `classname` - the node name as written on the building code groovy [Java] Class NodeBuilder [Java] Class NodeBuilder ======================== * groovy.util.NodeBuilder ``` public class NodeBuilder extends [BuilderSupport](buildersupport) ``` A helper class for creating nested trees of Node objects for handling arbitrary data Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[createNode](#createNode(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name)` \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[createNode](#createNode(java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[createNode](#createNode(java.lang.Object,%20java.util.Map))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[createNode](#createNode(java.lang.Object,%20java.util.Map,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| \| \| `protected [Node](node)` \| `[getCurrentNode](#getCurrentNode())()` \| \| \| `public static [NodeBuilder](nodebuilder)` \| `[newInstance](#newInstance())()` \| \| \| `protected void` \| `[setParent](#setParent(java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [BuilderSupport](buildersupport)` \| `[createNode](buildersupport#createNode(java.lang.Object)), [createNode](buildersupport#createNode(java.lang.Object,%20java.lang.Object)), [createNode](buildersupport#createNode(java.lang.Object,%20java.util.Map)), [createNode](buildersupport#createNode(java.lang.Object,%20java.util.Map,%20java.lang.Object)), [doInvokeMethod](buildersupport#doInvokeMethod(java.lang.String,%20java.lang.Object,%20java.lang.Object)), [getCurrent](buildersupport#getCurrent()), [getName](buildersupport#getName(java.lang.String)), [invokeMethod](buildersupport#invokeMethod(java.lang.String)), [invokeMethod](buildersupport#invokeMethod(java.lang.String,%20java.lang.Object)), [nodeCompleted](buildersupport#nodeCompleted(java.lang.Object,%20java.lang.Object)), [postNodeCompletion](buildersupport#postNodeCompletion(java.lang.Object,%20java.lang.Object)), [setClosureDelegate](buildersupport#setClosureDelegate(groovy.lang.Closure,%20java.lang.Object)), [setCurrent](buildersupport#setCurrent(java.lang.Object)), [setParent](buildersupport#setParent(java.lang.Object,%20java.lang.Object))` \| \| `class [GroovyObjectSupport](../lang/groovyobjectsupport)` \| `[getMetaClass](../lang/groovyobjectsupport#getMetaClass()), [setMetaClass](../lang/groovyobjectsupport#setMetaClass(groovy.lang.MetaClass))` \| Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") createNode([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") createNode([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") createNode([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") createNode([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) ### protected [Node](node) getCurrentNode() ### public static [NodeBuilder](nodebuilder) newInstance() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected void setParent([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child) groovy [Java] Class ObservableSet<E> [Java] Class ObservableSet<E> ============================= * groovy.util.ObservableSet All Implemented Interfaces and Traits: [Set](https://docs.oracle.com/javase/8/docs/api/java/util/Set.html "Set") ``` public class ObservableSet<E> extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") implements [Set](https://docs.oracle.com/javase/8/docs/api/java/util/Set.html "Set") ``` Set decorator that will trigger PropertyChangeEvents when a value changes. An optional Closure may be specified and will work as a filter, if it returns true the property will trigger an event (if the value indeed changed), otherwise it won't. The Closure may receive 1 or 2 parameters, the single one being the value, the other one both the key and value, for example: ``` // skip all properties whose value is a closure def set = new ObservableSet( {!(it instanceof Closure)} ) <p/> // skip all properties whose name matches a regex def set = new ObservableSet( { name, value -> !(name =˜ /[A-Z+]/) } ) ``` The current implementation will trigger specialized events in the following scenarios, you need not register a different listener as those events extend from PropertyChangeEvent * ObservableSet.ElementAddedEvent - a new element is added to the set * ObservableSet.ElementRemovedEvent - an element is removed from the set * ObservableSet.ElementUpdatedEvent - an element changes value (same as regular PropertyChangeEvent) * ObservableSet.ElementClearedEvent - all elements have been removed from the list * ObservableSet.MultiElementAddedEvent - triggered by calling set.addAll() * ObservableSet.MultiElementRemovedEvent - triggered by calling set.removeAll()/set.retainAll() Bound properties * content - read-only. * size - read-only. Nested Class Summary -------------------- Nested classes \| Modifiers \| Name \| Description \| \| `enum` \| `[ObservableSet.ChangeType](observableset.changetype)` \| \| \| `static class` \| `[ObservableSet.ElementAddedEvent](observableset.elementaddedevent)` \| \| \| `static class` \| `[ObservableSet.ElementClearedEvent](observableset.elementclearedevent)` \| \| \| `static class` \| `[ObservableSet.ElementEvent](observableset.elementevent)` \| \| \| `static class` \| `[ObservableSet.ElementRemovedEvent](observableset.elementremovedevent)` \| \| \| `static class` \| `[ObservableSet.MultiElementAddedEvent](observableset.multielementaddedevent)` \| \| \| `static class` \| `[ObservableSet.MultiElementRemovedEvent](observableset.multielementremovedevent)` \| \| \| `protected class` \| `[ObservableSet.ObservableIterator](observableset.observableiterator)` \| \| Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[CONTENT\_PROPERTY](#CONTENT_PROPERTY)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[SIZE\_PROPERTY](#SIZE_PROPERTY)` \| \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[ObservableSet](#ObservableSet())()` \| \| `[ObservableSet](#ObservableSet(Set))([Set](https://docs.oracle.com/javase/8/docs/api/java/util/Set.html "Set")<E> delegate)` \| \| `[ObservableSet](#ObservableSet(groovy.lang.Closure))([Closure](../lang/closure) test)` \| \| `[ObservableSet](#ObservableSet(Set,%20groovy.lang.Closure))([Set](https://docs.oracle.com/javase/8/docs/api/java/util/Set.html "Set")<E> delegate, [Closure](../lang/closure) test)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public boolean` \| `[add](#add(E))(E e)` \| \| \| `public boolean` \| `[addAll](#addAll(Collection))([Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection")<? extends E> c)` \| \| \| `public void` \| `[addPropertyChangeListener](#addPropertyChangeListener(java.beans.PropertyChangeListener))([PropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html "PropertyChangeListener") listener)` \| \| \| `public void` \| `[addPropertyChangeListener](#addPropertyChangeListener(java.lang.String,%20java.beans.PropertyChangeListener))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") propertyName, [PropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html "PropertyChangeListener") listener)` \| \| \| `public void` \| `[clear](#clear())()` \| \| \| `public boolean` \| `[contains](#contains(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o)` \| \| \| `public boolean` \| `[containsAll](#containsAll(Collection))([Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection")<?> objects)` \| \| \| `protected void` \| `[fireElementAddedEvent](#fireElementAddedEvent(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") element)` \| \| \| `protected void` \| `[fireElementClearedEvent](#fireElementClearedEvent(java.util.List))([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") values)` \| \| \| `protected void` \| `[fireElementEvent](#fireElementEvent(ElementEvent))([ElementEvent](../../elementevent) event)` \| \| \| `protected void` \| `[fireElementRemovedEvent](#fireElementRemovedEvent(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") element)` \| \| \| `protected void` \| `[fireMultiElementAddedEvent](#fireMultiElementAddedEvent(java.util.List))([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") values)` \| \| \| `protected void` \| `[fireMultiElementRemovedEvent](#fireMultiElementRemovedEvent(java.util.List))([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") values)` \| \| \| `protected void` \| `[fireSizeChangedEvent](#fireSizeChangedEvent(int,%20int))(int oldValue, int newValue)` \| \| \| `public [Set](https://docs.oracle.com/javase/8/docs/api/java/util/Set.html "Set")<E>` \| `[getContent](#getContent())()` \| \| \| `protected [Set](https://docs.oracle.com/javase/8/docs/api/java/util/Set.html "Set")<E>` \| `[getDelegateSet](#getDelegateSet())()` \| \| \| `public [PropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html "PropertyChangeListener")[]` \| `[getPropertyChangeListeners](#getPropertyChangeListeners())()` \| \| \| `public [PropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html "PropertyChangeListener")[]` \| `[getPropertyChangeListeners](#getPropertyChangeListeners(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") propertyName)` \| \| \| `protected [Closure](../lang/closure)` \| `[getTest](#getTest())()` \| \| \| `public boolean` \| `[hasListeners](#hasListeners(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") propertyName)` \| \| \| `public boolean` \| `[isEmpty](#isEmpty())()` \| \| \| `public [Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html "Iterator")<E>` \| `[iterator](#iterator())()` \| \| \| `public boolean` \| `[remove](#remove(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o)` \| \| \| `public boolean` \| `[removeAll](#removeAll(Collection))([Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection")<?> c)` \| \| \| `public void` \| `[removePropertyChangeListener](#removePropertyChangeListener(java.beans.PropertyChangeListener))([PropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html "PropertyChangeListener") listener)` \| \| \| `public void` \| `[removePropertyChangeListener](#removePropertyChangeListener(java.lang.String,%20java.beans.PropertyChangeListener))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") propertyName, [PropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html "PropertyChangeListener") listener)` \| \| \| `public boolean` \| `[retainAll](#retainAll(Collection))([Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection")<?> c)` \| \| \| `public int` \| `[size](#size())()` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[]` \| `[toArray](#toArray())()` \| \| `<T>` \| `public T[]` \| `[toArray](#toArray(T))(T[] ts)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Field Detail ------------ ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") CONTENT\_PROPERTY ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") SIZE\_PROPERTY Constructor Detail ------------------ ### public ObservableSet() ### public ObservableSet([Set](https://docs.oracle.com/javase/8/docs/api/java/util/Set.html "Set")<E> delegate) ### public ObservableSet([Closure](../lang/closure) test) ### public ObservableSet([Set](https://docs.oracle.com/javase/8/docs/api/java/util/Set.html "Set")<E> delegate, [Closure](../lang/closure) test) Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean add(E e) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean addAll([Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection")<? extends E> c) ### public void addPropertyChangeListener([PropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html "PropertyChangeListener") listener) ### public void addPropertyChangeListener([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") propertyName, [PropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html "PropertyChangeListener") listener) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void clear() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean contains([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean containsAll([Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection")<?> objects) ### protected void fireElementAddedEvent([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") element) ### protected void fireElementClearedEvent([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") values) ### protected void fireElementEvent([ElementEvent](../../elementevent) event) ### protected void fireElementRemovedEvent([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") element) ### protected void fireMultiElementAddedEvent([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") values) ### protected void fireMultiElementRemovedEvent([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") values) ### protected void fireSizeChangedEvent(int oldValue, int newValue) ### public [Set](https://docs.oracle.com/javase/8/docs/api/java/util/Set.html "Set")<E> getContent() ### protected [Set](https://docs.oracle.com/javase/8/docs/api/java/util/Set.html "Set")<E> getDelegateSet() ### public [PropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html "PropertyChangeListener")[] getPropertyChangeListeners() ### public [PropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html "PropertyChangeListener")[] getPropertyChangeListeners([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") propertyName) ### protected [Closure](../lang/closure) getTest() ### public boolean hasListeners([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") propertyName) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean isEmpty() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html "Iterator")<E> iterator() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean remove([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean removeAll([Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection")<?> c) ### public void removePropertyChangeListener([PropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html "PropertyChangeListener") listener) ### public void removePropertyChangeListener([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") propertyName, [PropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html "PropertyChangeListener") listener) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean retainAll([Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection")<?> c) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public int size() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] toArray() ### <T> @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public T[] toArray(T[] ts)	programming_docs
groovy [Java] Class ObservableList.ObservableIterator [Java] Class ObservableList.ObservableIterator ============================================== * groovy.util.ObservableList.ObservableIterator All Implemented Interfaces and Traits: [Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html "Iterator") ``` protected class ObservableList.ObservableIterator ``` Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `protected int` \| `[cursor](#cursor)` \| \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[ObservableIterator](#ObservableIterator(java.util.Iterator))([Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html "Iterator") iterDelegate)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html "Iterator")` \| `[getDelegate](#getDelegate())()` \| \| \| `public boolean` \| `[hasNext](#hasNext())()` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[next](#next())()` \| \| \| `public void` \| `[remove](#remove())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Field Detail ------------ ### protected int cursor Constructor Detail ------------------ ### public ObservableIterator([Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html "Iterator") iterDelegate) Method Detail ------------- ### public [Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html "Iterator") getDelegate() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean hasNext() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") next() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void remove() groovy [Java] Class ObservableSet.MultiElementRemovedEvent [Java] Class ObservableSet.MultiElementRemovedEvent =================================================== * groovy.util.ObservableSet.MultiElementRemovedEvent ``` public static class ObservableSet.MultiElementRemovedEvent extends [ElementEvent](../../elementevent) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[MultiElementRemovedEvent](#MultiElementRemovedEvent(java.lang.Object,%20java.util.List))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") source, [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") values)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")` \| `[getValues](#getValues())()` \| Constructor Detail ------------------ ### public MultiElementRemovedEvent([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") source, [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") values) Method Detail ------------- ### public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") getValues() groovy [Java] Class BuilderSupport [Java] Class BuilderSupport =========================== * groovy.util.BuilderSupport ``` public abstract class BuilderSupport extends [GroovyObjectSupport](../lang/groovyobjectsupport) ``` Base class for creating arbitrary nested trees of objects or events. Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[BuilderSupport](#BuilderSupport())()` \| \| `[BuilderSupport](#BuilderSupport(groovy.util.BuilderSupport))([BuilderSupport](buildersupport) proxyBuilder)` \| \| `[BuilderSupport](#BuilderSupport(groovy.lang.Closure,%20groovy.util.BuilderSupport))([Closure](../lang/closure) nameMappingClosure, [BuilderSupport](buildersupport) proxyBuilder)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `protected abstract [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[createNode](#createNode(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name)` \| \| \| `protected abstract [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[createNode](#createNode(java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| \| \| `protected abstract [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[createNode](#createNode(java.lang.Object,%20java.util.Map))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| \| \| `protected abstract [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[createNode](#createNode(java.lang.Object,%20java.util.Map,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[doInvokeMethod](#doInvokeMethod(java.lang.String,%20java.lang.Object,%20java.lang.Object))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args)` \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getCurrent](#getCurrent())()` \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getName](#getName(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName)`A hook to allow names to be converted into some other object such as a QName in XML or ObjectName in JMX. \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[invokeMethod](#invokeMethod(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName)`Convenience method when no arguments are required. \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[invokeMethod](#invokeMethod(java.lang.String,%20java.lang.Object))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args)` \| \| \| `protected void` \| `[nodeCompleted](#nodeCompleted(java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node)`A hook to allow nodes to be processed once they have had all of their children applied. \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[postNodeCompletion](#postNodeCompletion(java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node)`A hook to allow nodes to be processed once they have had all of their children applied and allows the actual node object that represents the Markup element to be changed. \| \| \| `protected void` \| `[setClosureDelegate](#setClosureDelegate(groovy.lang.Closure,%20java.lang.Object))([Closure](../lang/closure) closure, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node)`A strategy method to allow derived builders to use builder-trees and switch in different kinds of builders. \| \| \| `protected void` \| `[setCurrent](#setCurrent(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") current)` \| \| \| `protected abstract void` \| `[setParent](#setParent(java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [GroovyObjectSupport](../lang/groovyobjectsupport)` \| `[getMetaClass](../lang/groovyobjectsupport#getMetaClass()), [setMetaClass](../lang/groovyobjectsupport#setMetaClass(groovy.lang.MetaClass))` \| Constructor Detail ------------------ ### public BuilderSupport() ### public BuilderSupport([BuilderSupport](buildersupport) proxyBuilder) ### public BuilderSupport(@[ClosureParams](../transform/stc/closureparams "ClosureParams")(value=SimpleType.class, options="java.lang.String") [Closure](../lang/closure) nameMappingClosure, [BuilderSupport](buildersupport) proxyBuilder) Method Detail ------------- ### protected abstract [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") createNode([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name) ### protected abstract [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") createNode([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) ### protected abstract [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") createNode([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) ### protected abstract [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") createNode([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) ### protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") doInvokeMethod([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args) ### protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getCurrent() ### protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getName([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName) A hook to allow names to be converted into some other object such as a QName in XML or ObjectName in JMX. Parameters: `methodName` - the name of the desired method Returns: the object representing the name ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") invokeMethod([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName) Convenience method when no arguments are required. Parameters: `methodName` - the name of the method to invoke Returns: the result of the call ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") invokeMethod([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args) ### protected void nodeCompleted([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node) A hook to allow nodes to be processed once they have had all of their children applied. Parameters: `node` - the current node being processed `parent` - the parent of the node being processed ### protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") postNodeCompletion([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node) A hook to allow nodes to be processed once they have had all of their children applied and allows the actual node object that represents the Markup element to be changed. Parameters: `node` - the current node being processed `parent` - the parent of the node being processed Returns: the node, possibly new, that represents the markup element ### protected void setClosureDelegate([Closure](../lang/closure) closure, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node) A strategy method to allow derived builders to use builder-trees and switch in different kinds of builders. This method should call the setDelegate() method on the closure which by default passes in this but if node is-a builder we could pass that in instead (or do something wacky too). Parameters: `closure` - the closure on which to call setDelegate() `node` - the node value that we've just created, which could be a builder ### protected void setCurrent([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") current) ### protected abstract void setParent([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child) groovy [Java] Class ObservableMap.PropertyClearedEvent [Java] Class ObservableMap.PropertyClearedEvent =============================================== * groovy.util.ObservableMap.PropertyClearedEvent ``` public static class ObservableMap.PropertyClearedEvent extends [PropertyEvent](../../propertyevent) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[PropertyClearedEvent](#PropertyClearedEvent(java.lang.Object,%20java.util.Map))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") source, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") values)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")` \| `[getValues](#getValues())()` \| Constructor Detail ------------------ ### public PropertyClearedEvent([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") source, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") values) Method Detail ------------- ### public [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") getValues() groovy [Java] Class ObservableList.ObservableListIterator [Java] Class ObservableList.ObservableListIterator ================================================== * groovy.util.ObservableList.ObservableListIterator All Implemented Interfaces and Traits: [ListIterator](https://docs.oracle.com/javase/8/docs/api/java/util/ListIterator.html "ListIterator") ``` protected class ObservableList.ObservableListIterator extends [ObservableIterator](../../observableiterator) implements [ListIterator](https://docs.oracle.com/javase/8/docs/api/java/util/ListIterator.html "ListIterator") ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[ObservableListIterator](#ObservableListIterator(java.util.ListIterator,%20int))([ListIterator](https://docs.oracle.com/javase/8/docs/api/java/util/ListIterator.html "ListIterator") iterDelegate, int index)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public void` \| `[add](#add(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o)` \| \| \| `public [ListIterator](https://docs.oracle.com/javase/8/docs/api/java/util/ListIterator.html "ListIterator")` \| `[getListIterator](#getListIterator())()` \| \| \| `public boolean` \| `[hasPrevious](#hasPrevious())()` \| \| \| `public int` \| `[nextIndex](#nextIndex())()` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[previous](#previous())()` \| \| \| `public int` \| `[previousIndex](#previousIndex())()` \| \| \| `public void` \| `[set](#set(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o)` \| Constructor Detail ------------------ ### public ObservableListIterator([ListIterator](https://docs.oracle.com/javase/8/docs/api/java/util/ListIterator.html "ListIterator") iterDelegate, int index) Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void add([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o) ### public [ListIterator](https://docs.oracle.com/javase/8/docs/api/java/util/ListIterator.html "ListIterator") getListIterator() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean hasPrevious() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public int nextIndex() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") previous() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public int previousIndex() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void set([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o)	programming_docs
groovy [Java] Class ConfigObject [Java] Class ConfigObject ========================= * groovy.util.ConfigObject All Implemented Interfaces and Traits: [Writable](../lang/writable), [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map"), [Cloneable](https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html "Cloneable") ``` public class ConfigObject extends [GroovyObjectSupport](../lang/groovyobjectsupport) implements [Writable](../lang/writable), [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map"), [Cloneable](https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html "Cloneable") ``` A ConfigObject at a simple level is a Map that creates configuration entries (other ConfigObjects) when referencing them. This means that navigating to foo.bar.stuff will not return null but nested ConfigObjects which are of course empty maps The Groovy truth can be used to check for the existence of "real" entries. Since: 1.5 Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[ConfigObject](#ConfigObject(java.net.URL))([URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html "URL") file)` \| \| `[ConfigObject](#ConfigObject())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public void` \| `[clear](#clear())()` \| \| \| `public [ConfigObject](configobject)` \| `[clone](#clone())()`Returns a shallow copy of this ConfigObject, keys and configuration entries are not cloned. \| \| \| `public boolean` \| `[containsKey](#containsKey(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") key)` \| \| \| `public boolean` \| `[containsValue](#containsValue(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| \| \| `public [Set](https://docs.oracle.com/javase/8/docs/api/java/util/Set.html "Set")` \| `[entrySet](#entrySet())()` \| \| \| `public [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")` \| `[flatten](#flatten())()`A ConfigObject is a tree structure consisting of nested maps. \| \| \| `public [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")` \| `[flatten](#flatten(java.util.Map))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") target)`Flattens this ConfigObject populating the results into the target Map \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[get](#get(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") key)` \| \| \| `public [URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html "URL")` \| `[getConfigFile](#getConfigFile())()` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getProperty](#getProperty(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name)`Overrides the default getProperty implementation to create nested ConfigObject instances on demand for non-existent keys \| \| \| `public boolean` \| `[isEmpty](#isEmpty())()` \| \| \| `public [Boolean](https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html "Boolean")` \| `[isSet](#isSet(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") option)`Checks if a config option is set. \| \| \| `public [Set](https://docs.oracle.com/javase/8/docs/api/java/util/Set.html "Set")` \| `[keySet](#keySet())()` \| \| \| `public [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")` \| `[merge](#merge(groovy.util.ConfigObject))([ConfigObject](configobject) other)`Merges the given map with this ConfigObject overriding any matching configuration entries in this ConfigObject \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[prettyPrint](#prettyPrint())()` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[put](#put(java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") key, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| \| \| `public void` \| `[putAll](#putAll(java.util.Map))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") m)` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[remove](#remove(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") key)` \| \| \| `public void` \| `[setConfigFile](#setConfigFile(java.net.URL))([URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html "URL") configFile)` \| \| \| `public int` \| `[size](#size())()` \| \| \| `public [Properties](https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html "Properties")` \| `[toProperties](#toProperties())()`Converts this ConfigObject into a the java.util.Properties format, flattening the tree structure beforehand \| \| \| `public [Properties](https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html "Properties")` \| `[toProperties](#toProperties(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") prefix)`Converts this ConfigObject ino the java.util.Properties format, flatten the tree and prefixing all entries with the given prefix \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[toString](#toString())()` \| \| \| `public [Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection")` \| `[values](#values())()` \| \| \| `public [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer")` \| `[writeTo](#writeTo(java.io.Writer))([Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") outArg)`Writes this config object into a String serialized representation which can later be parsed back using the parse() method \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [GroovyObjectSupport](../lang/groovyobjectsupport)` \| `[getMetaClass](../lang/groovyobjectsupport#getMetaClass()), [setMetaClass](../lang/groovyobjectsupport#setMetaClass(groovy.lang.MetaClass))` \| Constructor Detail ------------------ ### public ConfigObject([URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html "URL") file) ### public ConfigObject() Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void clear() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ConfigObject](configobject) clone() Returns a shallow copy of this ConfigObject, keys and configuration entries are not cloned. Returns: a shallow copy of this ConfigObject ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean containsKey([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") key) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean containsValue([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Set](https://docs.oracle.com/javase/8/docs/api/java/util/Set.html "Set") entrySet() ### public [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") flatten() A ConfigObject is a tree structure consisting of nested maps. This flattens the maps into a single level structure like a properties file ### public [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") flatten([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") target) Flattens this ConfigObject populating the results into the target Map See Also: [ConfigObject.flatten](configobject#flatten() "ConfigObject.flatten") ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") get([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") key) ### public [URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html "URL") getConfigFile() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getProperty([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name) Overrides the default getProperty implementation to create nested ConfigObject instances on demand for non-existent keys ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean isEmpty() ### public [Boolean](https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html "Boolean") isSet([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") option) Checks if a config option is set. Example usage: ``` def config = new ConfigSlurper().parse("foo { password='' }") assert config.foo.isSet('password') assert config.foo.isSet('username') == false ``` The check works only for options one block below the current block. E.g. `config.isSet('foo.password')` will always return false. Parameters: `option` - The name of the option Returns: `true` if the option is set `false` otherwise Since: 2.3.0 ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Set](https://docs.oracle.com/javase/8/docs/api/java/util/Set.html "Set") keySet() ### public [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") merge([ConfigObject](configobject) other) Merges the given map with this ConfigObject overriding any matching configuration entries in this ConfigObject Parameters: `other` - The ConfigObject to merge with Returns: The result of the merge ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") prettyPrint() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") put([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") key, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void putAll([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") m) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") remove([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") key) ### public void setConfigFile([URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html "URL") configFile) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public int size() ### public [Properties](https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html "Properties") toProperties() Converts this ConfigObject into a the java.util.Properties format, flattening the tree structure beforehand Returns: A java.util.Properties instance ### public [Properties](https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html "Properties") toProperties([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") prefix) Converts this ConfigObject ino the java.util.Properties format, flatten the tree and prefixing all entries with the given prefix Parameters: `prefix` - The prefix to append before property entries Returns: A java.util.Properties instance ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") toString() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection") values() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") writeTo([Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") outArg) Writes this config object into a String serialized representation which can later be parsed back using the parse() method See Also: [Writable.writeTo](../lang/writable#writeTo(java.io.Writer) "Writable.writeTo") groovy [Java] Interface ObjectGraphBuilder.IdentifierResolver [Java] Interface ObjectGraphBuilder.IdentifierResolver ====================================================== ``` public interface ObjectGraphBuilder.IdentifierResolver ``` Strategy for picking the correct synthetic identifier. Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getIdentifierFor](#getIdentifierFor(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") nodeName)`Returns the name of the property that will identify the node. \| Method Detail ------------- ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getIdentifierFor([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") nodeName) Returns the name of the property that will identify the node. Parameters: `nodeName` - the name of the node groovy [Java] Class ObservableSet.ElementAddedEvent [Java] Class ObservableSet.ElementAddedEvent ============================================ * groovy.util.ObservableSet.ElementAddedEvent ``` public static class ObservableSet.ElementAddedEvent extends [ElementEvent](../../elementevent) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[ElementAddedEvent](#ElementAddedEvent(java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") source, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newValue)` \| Constructor Detail ------------------ ### public ElementAddedEvent([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") source, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newValue) groovy [Java] Class ObservableMap.PropertyRemovedEvent [Java] Class ObservableMap.PropertyRemovedEvent =============================================== * groovy.util.ObservableMap.PropertyRemovedEvent ``` public static class ObservableMap.PropertyRemovedEvent extends [PropertyEvent](../../propertyevent) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[PropertyRemovedEvent](#PropertyRemovedEvent(java.lang.Object,%20java.lang.String,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") source, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") propertyName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") oldValue)` \| Constructor Detail ------------------ ### public PropertyRemovedEvent([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") source, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") propertyName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") oldValue) groovy [Java] Class MapEntry [Java] Class MapEntry ===================== * groovy.util.MapEntry All Implemented Interfaces and Traits: [MapEntry](mapentry) ``` public class MapEntry extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") implements [MapEntry](mapentry) ``` A Map.Entry implementation. Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[MapEntry](#MapEntry(java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") key, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public boolean` \| `[equals](#equals(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") that)` \| \| \| `public boolean` \| `[equals](#equals(groovy.util.MapEntry))([MapEntry](mapentry) that)` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getKey](#getKey())()` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getValue](#getValue())()` \| \| \| `protected int` \| `[hash](#hash(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object)`Helper method to handle object hashes for possibly null values \| \| \| `public int` \| `[hashCode](#hashCode())()` \| \| \| `public void` \| `[setKey](#setKey(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") key)` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[setValue](#setValue(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[toString](#toString())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public MapEntry([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") key, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean equals([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") that) ### public boolean equals([MapEntry](mapentry) that) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getKey() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getValue() ### protected int hash([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object) Helper method to handle object hashes for possibly null values ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public int hashCode() ### public void setKey([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") key) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") setValue([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") toString()	programming_docs
groovy [Java] Class IndentPrinter [Java] Class IndentPrinter ========================== * groovy.util.IndentPrinter ``` public class IndentPrinter extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` A helper class for printing indented text. This can be used stand-alone or, more commonly, from Builders. By default, a PrintWriter to System.out is used as the Writer, but it is possible to change the Writer by passing a new one as a constructor argument. Indention by default is 2 characters but can be changed by passing a different value as a constructor argument. The following is an example usage. Note that within a "with" block you need to specify a parameter name so that this.println is not called instead of IndentPrinter.println: ``` new IndentPrinter(new PrintWriter(out)).with { p -> p.printIndent() p.println('parent1') p.incrementIndent() p.printIndent() p.println('child 1') p.printIndent() p.println('child 2') p.decrementIndent() p.printIndent() p.println('parent2') p.flush() } ``` The above example prints this to standard output: ``` parent1 child 1 child 2 parent2 ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[IndentPrinter](#IndentPrinter())()`Creates an IndentPrinter backed by a PrintWriter pointing to System.out, with an indent of two spaces. \| \| `[IndentPrinter](#IndentPrinter(java.io.Writer))([Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") out)`Creates an IndentPrinter backed by the supplied Writer, with an indent of two spaces. \| \| `[IndentPrinter](#IndentPrinter(java.io.Writer,%20java.lang.String))([Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") out, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") indent)`Creates an IndentPrinter backed by the supplied Writer, with a user-supplied String to be used for indenting. \| \| `[IndentPrinter](#IndentPrinter(java.io.Writer,%20java.lang.String,%20boolean))([Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") out, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") indent, boolean addNewlines)`Creates an IndentPrinter backed by the supplied Writer, with a user-supplied String to be used for indenting and the ability to override newline handling. \| \| `[IndentPrinter](#IndentPrinter(java.io.Writer,%20java.lang.String,%20boolean,%20boolean))([Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") out, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") indent, boolean addNewlines, boolean autoIndent)`Create an IndentPrinter to the given PrintWriter \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public void` \| `[decrementIndent](#decrementIndent())()` \| \| \| `public void` \| `[flush](#flush())()` \| \| \| `public boolean` \| `[getAutoIndent](#getAutoIndent())()` \| \| \| `public int` \| `[getIndentLevel](#getIndentLevel())()` \| \| \| `public void` \| `[incrementIndent](#incrementIndent())()` \| \| \| `public void` \| `[print](#print(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text)`Prints a string. \| \| \| `public void` \| `[print](#print(char))(char c)`Prints a character. \| \| \| `public void` \| `[printIndent](#printIndent())()`Prints the current indent level. \| \| \| `public void` \| `[println](#println(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text)`Prints a string followed by an end of line character. \| \| \| `public void` \| `[println](#println())()`Prints an end-of-line character (if enabled via addNewLines property). \| \| \| `public void` \| `[setAutoIndent](#setAutoIndent(boolean))(boolean autoIndent)` \| \| \| `public void` \| `[setIndentLevel](#setIndentLevel(int))(int indentLevel)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public IndentPrinter() Creates an IndentPrinter backed by a PrintWriter pointing to System.out, with an indent of two spaces. See Also: [IndentPrinter(Writer, String)](#IndentPrinter(java.io.Writer,%20java.lang.String)) ### public IndentPrinter([Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") out) Creates an IndentPrinter backed by the supplied Writer, with an indent of two spaces. Parameters: `out` - Writer to output to See Also: [IndentPrinter(Writer, String)](#IndentPrinter(java.io.Writer,%20java.lang.String)) ### public IndentPrinter([Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") out, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") indent) Creates an IndentPrinter backed by the supplied Writer, with a user-supplied String to be used for indenting. Parameters: `out` - Writer to output to `indent` - character(s) used to indent each line ### public IndentPrinter([Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") out, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") indent, boolean addNewlines) Creates an IndentPrinter backed by the supplied Writer, with a user-supplied String to be used for indenting and the ability to override newline handling. Parameters: `out` - Writer to output to `indent` - character(s) used to indent each line `addNewlines` - set to false to gobble all new lines (default true) ### public IndentPrinter([Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") out, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") indent, boolean addNewlines, boolean autoIndent) Create an IndentPrinter to the given PrintWriter Parameters: `out` - Writer to output to `indent` - character(s) used to indent each line `addNewlines` - set to false to gobble all new lines (default true) `autoIndent` - set to true to make println() prepend the indent automatically (default false) Method Detail ------------- ### public void decrementIndent() ### public void flush() ### public boolean getAutoIndent() ### public int getIndentLevel() ### public void incrementIndent() ### public void print([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text) Prints a string. Parameters: `text` - String to be written ### public void print(char c) Prints a character. Parameters: `c` - char to be written ### public void printIndent() Prints the current indent level. ### public void println([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text) Prints a string followed by an end of line character. Parameters: `text` - String to be written ### public void println() Prints an end-of-line character (if enabled via addNewLines property). Defaults to outputting a single '\n' character but by using a custom Writer, e.g. PlatformLineWriter, you can get platform-specific end-of-line characters. See Also: [IndentPrinter(Writer, String, boolean)](#IndentPrinter(java.io.Writer,%20java.lang.String,%20boolean)) ### public void setAutoIndent(boolean autoIndent) ### public void setIndentLevel(int indentLevel) groovy [Java] Class ResourceException [Java] Class ResourceException ============================== * groovy.util.ResourceException ``` public class ResourceException extends [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html "Exception") ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[ResourceException](#ResourceException())()` \| \| `[ResourceException](#ResourceException(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message)` Parameters: message \| \| `[ResourceException](#ResourceException(java.lang.String,%20java.lang.Throwable))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message, [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html "Throwable") cause)` Parameters: message \| \| `[ResourceException](#ResourceException(java.lang.Throwable))([Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html "Throwable") cause)` Parameters: cause \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html "Exception")` \| `[printStackTrace](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html#printStackTrace() "printStackTrace"), [printStackTrace](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html#printStackTrace(java.io.PrintStream) "printStackTrace"), [printStackTrace](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html#printStackTrace(java.io.PrintWriter) "printStackTrace"), [fillInStackTrace](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html#fillInStackTrace() "fillInStackTrace"), [getCause](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html#getCause() "getCause"), [initCause](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html#initCause(java.lang.Throwable) "initCause"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html#toString() "toString"), [getMessage](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html#getMessage() "getMessage"), [getSuppressed](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html#getSuppressed() "getSuppressed"), [getLocalizedMessage](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html#getLocalizedMessage() "getLocalizedMessage"), [getStackTrace](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html#getStackTrace() "getStackTrace"), [setStackTrace](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html#setStackTrace(%5BLjava.lang.StackTraceElement;) "setStackTrace"), [addSuppressed](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html#addSuppressed(java.lang.Throwable) "addSuppressed"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html#equals(java.lang.Object) "equals"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public ResourceException() ### public ResourceException([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message) Parameters: message ### public ResourceException([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message, [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html "Throwable") cause) Parameters: message cause ### public ResourceException([Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html "Throwable") cause) Parameters: cause groovy [Java] Class Proxy [Java] Class Proxy ================== * groovy.util.Proxy ``` public class Proxy extends [GroovyObjectSupport](../lang/groovyobjectsupport) ``` Dynamic groovy proxy for another object. All method invocations get forwarded to actual object, unless the proxy overrides it. See groovy/util/ProxyTest.groovy for usage details. Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getAdaptee](#getAdaptee())()` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[invokeMethod](#invokeMethod(java.lang.String,%20java.lang.Object))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args)` \| \| \| `public [Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html "Iterator")` \| `[iterator](#iterator())()` \| \| \| `public void` \| `[setAdaptee](#setAdaptee(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") adaptee)` \| \| \| `public [Proxy](proxy)` \| `[wrap](#wrap(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") adaptee)`This method is for convenience. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [GroovyObjectSupport](../lang/groovyobjectsupport)` \| `[getMetaClass](../lang/groovyobjectsupport#getMetaClass()), [setMetaClass](../lang/groovyobjectsupport#setMetaClass(groovy.lang.MetaClass))` \| Method Detail ------------- ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getAdaptee() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") invokeMethod([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args) ### public [Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html "Iterator") iterator() ### public void setAdaptee([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") adaptee) ### public [Proxy](proxy) wrap([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") adaptee) This method is for convenience. It allows to get around the need for defining dump ctors in subclasses. See unit tests for details. groovy [Java] Class ObservableMap.PropertyEvent [Java] Class ObservableMap.PropertyEvent ======================================== * groovy.util.ObservableMap.PropertyEvent ``` public static abstract class ObservableMap.PropertyEvent extends [PropertyChangeEvent](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html "PropertyChangeEvent") ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[PropertyEvent](#PropertyEvent(java.lang.Object,%20java.lang.String,%20java.lang.Object,%20java.lang.Object,%20ChangeType))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") source, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") propertyName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") oldValue, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newValue, [ChangeType](../../changetype) type)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [ChangeType](../../changetype)` \| `[getChangeType](#getChangeType())()` \| \| \| `public int` \| `[getType](#getType())()` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getTypeAsString](#getTypeAsString())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [PropertyChangeEvent](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html "PropertyChangeEvent")` \| `[toString](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html#toString() "toString"), [getPropertyName](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html#getPropertyName() "getPropertyName"), [getOldValue](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html#getOldValue() "getOldValue"), [getPropagationId](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html#getPropagationId() "getPropagationId"), [setPropagationId](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html#setPropagationId(java.lang.Object) "setPropagationId"), [getNewValue](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html#getNewValue() "getNewValue"), [getSource](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html#getSource() "getSource"), [wait](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html#equals(java.lang.Object) "equals"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public PropertyEvent([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") source, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") propertyName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") oldValue, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newValue, [ChangeType](../../changetype) type) Method Detail ------------- ### public [ChangeType](../../changetype) getChangeType() ### public int getType() ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getTypeAsString()	programming_docs
groovy [Java] Interface BufferedIterator<T> [Java] Interface BufferedIterator<T> ==================================== ``` public interface BufferedIterator<T> extends [Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html "Iterator") ``` An iterator that allows examining the next element without consuming it. Since: 2.5.0 Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public T` \| `[head](#head())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `interface [Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html "Iterator")` \| `[remove](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html#remove() "remove"), [forEachRemaining](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html#forEachRemaining(java.util.function.Consumer) "forEachRemaining"), [hasNext](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html#hasNext() "hasNext"), [next](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html#next() "next")` \| Method Detail ------------- ### public T head() groovy [Java] Enum ObservableList.ChangeType [Java] Enum ObservableList.ChangeType ===================================== * groovy.util.ObservableList.ChangeType ``` public enum ObservableList.ChangeType ``` Enum Constants Summary ---------------------- Enum constants classes \| Enum constant \| Description \| \| `[ADDED](#ADDED)` \| \| \| `[CLEARED](#CLEARED)` \| \| \| `[MULTI\_ADD](#MULTI_ADD)` \| \| \| `[MULTI\_REMOVE](#MULTI_REMOVE)` \| \| \| `[NONE](#NONE)` \| \| \| `[REMOVED](#REMOVED)` \| \| \| `[UPDATED](#UPDATED)` \| \| Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newValue](#newValue)` \| \| \| `static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[oldValue](#oldValue)` \| \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public static [ChangeType](../../changetype)` \| `[resolve](#resolve(int))(int ordinal)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Enum Constant Detail -------------------- ### public [ObservableList.ChangeType](observablelist.changetype) ADDED ### public [ObservableList.ChangeType](observablelist.changetype) CLEARED ### public [ObservableList.ChangeType](observablelist.changetype) MULTI\_ADD ### public [ObservableList.ChangeType](observablelist.changetype) MULTI\_REMOVE ### public [ObservableList.ChangeType](observablelist.changetype) NONE ### public [ObservableList.ChangeType](observablelist.changetype) REMOVED ### public [ObservableList.ChangeType](observablelist.changetype) UPDATED Field Detail ------------ ### public static final [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newValue ### public static final [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") oldValue Method Detail ------------- ### public static [ChangeType](../../changetype) resolve(int ordinal) groovy [Java] Class CharsetToolkit [Java] Class CharsetToolkit =========================== * groovy.util.CharsetToolkit ``` public class CharsetToolkit extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Utility class to guess the encoding of a given text file. Unicode files encoded in UTF-16 (low or big endian) or UTF-8 files with a Byte Order Marker are correctly discovered. For UTF-8 files with no BOM, if the buffer is wide enough, the charset should also be discovered. A byte buffer of 4KB is used to be able to guess the encoding. Usage: ``` CharsetToolkit toolkit = new CharsetToolkit(file); // guess the encoding Charset guessedCharset = toolkit.getCharset(); // create a reader with the correct charset BufferedReader reader = toolkit.getReader(); // read the file content String line; while ((line = br.readLine())!= null) { System.out.println(line); } ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[CharsetToolkit](#CharsetToolkit(java.io.File))([File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File") file)`Constructor of the `CharsetToolkit` utility class. \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public static [Charset](https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html "Charset")[]` \| `[getAvailableCharsets](#getAvailableCharsets())()`Retrieves all the available `Charset`s on the platform, among which the default `charset`. \| \| \| `public [Charset](https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html "Charset")` \| `[getCharset](#getCharset())()` \| \| \| `public [Charset](https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html "Charset")` \| `[getDefaultCharset](#getDefaultCharset())()`Retrieves the default Charset \| \| \| `public static [Charset](https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html "Charset")` \| `[getDefaultSystemCharset](#getDefaultSystemCharset())()`Retrieve the default charset of the system. \| \| \| `public boolean` \| `[getEnforce8Bit](#getEnforce8Bit())()`Gets the enforce8Bit flag, in case we do not want to ever get a US-ASCII encoding. \| \| \| `public [BufferedReader](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedReader.html "BufferedReader")` \| `[getReader](#getReader())()`Gets a `BufferedReader` (indeed a `LineNumberReader`) from the `File` specified in the constructor of `CharsetToolkit` using the charset discovered or the default charset if an 8-bit `Charset` is encountered. \| \| \| `public boolean` \| `[hasUTF16BEBom](#hasUTF16BEBom())()`Has a Byte Order Marker for UTF-16 Big Endian (utf-16 and ucs-2). \| \| \| `public boolean` \| `[hasUTF16LEBom](#hasUTF16LEBom())()`Has a Byte Order Marker for UTF-16 Low Endian (ucs-2le, ucs-4le, and ucs-16le). \| \| \| `public boolean` \| `[hasUTF8Bom](#hasUTF8Bom())()`Has a Byte Order Marker for UTF-8 (Used by Microsoft's Notepad and other editors). \| \| \| `public void` \| `[setDefaultCharset](#setDefaultCharset(java.nio.charset.Charset))([Charset](https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html "Charset") defaultCharset)`Defines the default `Charset` used in case the buffer represents an 8-bit `Charset`. \| \| \| `public void` \| `[setEnforce8Bit](#setEnforce8Bit(boolean))(boolean enforce)`If US-ASCII is recognized, enforce to return the default encoding, rather than US-ASCII. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public CharsetToolkit([File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File") file) Constructor of the `CharsetToolkit` utility class. Parameters: `file` - of which we want to know the encoding. Method Detail ------------- ### public static [Charset](https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html "Charset")[] getAvailableCharsets() Retrieves all the available `Charset`s on the platform, among which the default `charset`. Returns: an array of `Charset`s. ### public [Charset](https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html "Charset") getCharset() ### public [Charset](https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html "Charset") getDefaultCharset() Retrieves the default Charset ### public static [Charset](https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html "Charset") getDefaultSystemCharset() Retrieve the default charset of the system. Returns: the default `Charset`. ### public boolean getEnforce8Bit() Gets the enforce8Bit flag, in case we do not want to ever get a US-ASCII encoding. Returns: a boolean representing the flag of use of US-ASCII. ### public [BufferedReader](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedReader.html "BufferedReader") getReader() Gets a `BufferedReader` (indeed a `LineNumberReader`) from the `File` specified in the constructor of `CharsetToolkit` using the charset discovered or the default charset if an 8-bit `Charset` is encountered. throws: FileNotFoundException if the file is not found. Returns: a `BufferedReader` ### public boolean hasUTF16BEBom() Has a Byte Order Marker for UTF-16 Big Endian (utf-16 and ucs-2). Returns: true if the buffer has a BOM for UTF-16 Big Endian. ### public boolean hasUTF16LEBom() Has a Byte Order Marker for UTF-16 Low Endian (ucs-2le, ucs-4le, and ucs-16le). Returns: true if the buffer has a BOM for UTF-16 Low Endian. ### public boolean hasUTF8Bom() Has a Byte Order Marker for UTF-8 (Used by Microsoft's Notepad and other editors). Returns: true if the buffer has a BOM for UTF8. ### public void setDefaultCharset([Charset](https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html "Charset") defaultCharset) Defines the default `Charset` used in case the buffer represents an 8-bit `Charset`. Parameters: `defaultCharset` - the default `Charset` to be returned if an 8-bit `Charset` is encountered. ### public void setEnforce8Bit(boolean enforce) If US-ASCII is recognized, enforce to return the default encoding, rather than US-ASCII. It might be a file without any special character in the range 128-255, but that may be or become a file encoded with the default `charset` rather than US-ASCII. Parameters: `enforce` - a boolean specifying the use or not of US-ASCII. groovy [Java] Enum ObservableSet.ChangeType [Java] Enum ObservableSet.ChangeType ==================================== * groovy.util.ObservableSet.ChangeType ``` public enum ObservableSet.ChangeType ``` Enum Constants Summary ---------------------- Enum constants classes \| Enum constant \| Description \| \| `[ADDED](#ADDED)` \| \| \| `[CLEARED](#CLEARED)` \| \| \| `[MULTI\_ADD](#MULTI_ADD)` \| \| \| `[MULTI\_REMOVE](#MULTI_REMOVE)` \| \| \| `[NONE](#NONE)` \| \| \| `[REMOVED](#REMOVED)` \| \| Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newValue](#newValue)` \| \| \| `static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[oldValue](#oldValue)` \| \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Enum Constant Detail -------------------- ### public [ObservableSet.ChangeType](observableset.changetype) ADDED ### public [ObservableSet.ChangeType](observableset.changetype) CLEARED ### public [ObservableSet.ChangeType](observableset.changetype) MULTI\_ADD ### public [ObservableSet.ChangeType](observableset.changetype) MULTI\_REMOVE ### public [ObservableSet.ChangeType](observableset.changetype) NONE ### public [ObservableSet.ChangeType](observableset.changetype) REMOVED Field Detail ------------ ### public static final [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newValue ### public static final [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") oldValue groovy [Java] Class ObjectGraphBuilder.ReflectionClassNameResolver [Java] Class ObjectGraphBuilder.ReflectionClassNameResolver =========================================================== * groovy.util.ObjectGraphBuilder.ReflectionClassNameResolver All Implemented Interfaces and Traits: [ClassNameResolver](../../classnameresolver) ``` public class ObjectGraphBuilder.ReflectionClassNameResolver ``` Build objects using reflection to resolve class names. Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[ReflectionClassNameResolver](#ReflectionClassNameResolver(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") root)` Parameters: `root` - package where the graph root class is located \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[resolveClassname](#resolveClassname(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") classname)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public ReflectionClassNameResolver([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") root) Parameters: `root` - package where the graph root class is located Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") resolveClassname([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") classname) groovy [Groovy] Class ConfigSlurper [Groovy] Class ConfigSlurper ============================ * groovy.util.ConfigSlurper ``` class ConfigSlurper extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` ConfigSlurper is a utility class for reading configuration files defined in the form of Groovy scripts. Configuration settings can be defined using dot notation or scoped using closures: ``` grails.webflow.stateless = true smtp { mail.host = 'smtp.myisp.com' mail.auth.user = 'server' } resources.URL = 'http://localhost:80/resources' ``` Settings can either be bound into nested maps or onto a specified JavaBean instance. In the latter case, an error will be thrown if a property cannot be bound. Since: 1.5 Properties Summary ------------------ Properties \| Type \| Name and description \| \| `[GroovyClassLoader](../lang/groovyclassloader "GroovyClassLoader")` \| `[classLoader](#classLoader)` \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[environment](#environment)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[ConfigSlurper](#ConfigSlurper())()` \| \| `[ConfigSlurper](#ConfigSlurper(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") env)`Constructs a new ConfigSlurper instance using the given environment \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>` \| `[getConditionalBlockValues](#getConditionalBlockValues())()` \| \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getEnvironment](#getEnvironment())()` \| \| \| `[ConfigObject](configobject)` \| `[parse](#parse(java.util.Properties))([Properties](https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html "Properties") properties)`Parses a ConfigObject instances from an instance of java.util.Properties \| \| \| `[ConfigObject](configobject)` \| `[parse](#parse(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") script)`Parse the given script as a string and return the configuration object \| \| \| `[ConfigObject](configobject)` \| `[parse](#parse(java.lang.Class))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") scriptClass)`Create a new instance of the given script class and parse a configuration object from it \| \| \| `[ConfigObject](configobject)` \| `[parse](#parse(groovy.lang.Script))([Script](../lang/script) script)`Parse the given script into a configuration object (a Map) (This method creates a new class to parse the script each time it is called.) \| \| \| `[ConfigObject](configobject)` \| `[parse](#parse(java.net.URL))([URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html "URL") scriptLocation)`Parses a Script represented by the given URL into a ConfigObject \| \| \| `[ConfigObject](configobject)` \| `[parse](#parse(groovy.lang.Script,%20java.net.URL))([Script](../lang/script) script, [URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html "URL") location)`Parses the passed groovy.lang.Script instance using the second argument to allow the ConfigObject to retain an reference to the original location other Groovy script \| \| \| `void` \| `[registerConditionalBlock](#registerConditionalBlock(java.lang.String,%20java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") blockName, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") blockValue)` \| \| \| `void` \| `[setBinding](#setBinding(java.util.Map))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") vars)`Sets any additional variables that should be placed into the binding when evaluating Config scripts \| \| \| `void` \| `[setEnvironment](#setEnvironment(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") environment)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Property Detail --------------- ### [GroovyClassLoader](../lang/groovyclassloader "GroovyClassLoader") classLoader ### [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") environment Constructor Detail ------------------ ### ConfigSlurper() ### ConfigSlurper([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") env) Constructs a new ConfigSlurper instance using the given environment Parameters: `env` - The Environment to use Method Detail ------------- ### [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> getConditionalBlockValues() ### [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getEnvironment() ### [ConfigObject](configobject) parse([Properties](https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html "Properties") properties) Parses a ConfigObject instances from an instance of java.util.Properties Parameters: `The` - java.util.Properties instance ### [ConfigObject](configobject) parse([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") script) Parse the given script as a string and return the configuration object See Also: [ConfigSlurper.parse](configslurper#parse(groovy.lang.Script) "ConfigSlurper.parse") ### [ConfigObject](configobject) parse([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") scriptClass) Create a new instance of the given script class and parse a configuration object from it See Also: [ConfigSlurper.parse](configslurper#parse(groovy.lang.Script) "ConfigSlurper.parse") ### [ConfigObject](configobject) parse([Script](../lang/script) script) Parse the given script into a configuration object (a Map) (This method creates a new class to parse the script each time it is called.) Parameters: `script` - The script to parse Returns: A Map of maps that can be navigating with dot de-referencing syntax to obtain configuration entries ### [ConfigObject](configobject) parse([URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html "URL") scriptLocation) Parses a Script represented by the given URL into a ConfigObject Parameters: `scriptLocation` - The location of the script to parse Returns: The ConfigObject instance ### @[SuppressWarnings](https://docs.oracle.com/javase/8/docs/api/java/lang/SuppressWarnings.html "SuppressWarnings")(value: Instanceof) [ConfigObject](configobject) parse([Script](../lang/script) script, [URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html "URL") location) Parses the passed groovy.lang.Script instance using the second argument to allow the ConfigObject to retain an reference to the original location other Groovy script Parameters: `script` - The groovy.lang.Script instance `location` - The original location of the Script as a URL Returns: The ConfigObject instance ### void registerConditionalBlock([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") blockName, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") blockValue) ### void setBinding([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") vars) Sets any additional variables that should be placed into the binding when evaluating Config scripts ### void setEnvironment([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") environment)	programming_docs
groovy [Java] Class ObjectGraphBuilder.DefaultNewInstanceResolver [Java] Class ObjectGraphBuilder.DefaultNewInstanceResolver ========================================================== * groovy.util.ObjectGraphBuilder.DefaultNewInstanceResolver All Implemented Interfaces and Traits: [NewInstanceResolver](../../newinstanceresolver) ``` public static class ObjectGraphBuilder.DefaultNewInstanceResolver ``` Default impl that calls Class.newInstance() Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(java.lang.Class,%20java.util.Map))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") klass, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") klass, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) groovy [Java] Class FactoryBuilderSupport [Java] Class FactoryBuilderSupport ================================== * groovy.util.FactoryBuilderSupport ``` public abstract class FactoryBuilderSupport extends [Binding](../lang/binding) ``` Mix of BuilderSupport and SwingBuilder's factory support. Warning: this implementation is not thread safe and should not be used across threads in a multi-threaded environment. A locking mechanism should be implemented by the subclass if use is expected across multiple threads. Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[CHILD\_BUILDER](#CHILD_BUILDER)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[CURRENT\_BUILDER](#CURRENT_BUILDER)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[CURRENT\_FACTORY](#CURRENT_FACTORY)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[CURRENT\_NAME](#CURRENT_NAME)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[CURRENT\_NODE](#CURRENT_NODE)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[OWNER](#OWNER)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[PARENT\_BUILDER](#PARENT_BUILDER)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[PARENT\_CONTEXT](#PARENT_CONTEXT)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[PARENT\_FACTORY](#PARENT_FACTORY)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[PARENT\_NAME](#PARENT_NAME)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[PARENT\_NODE](#PARENT_NODE)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[SCRIPT\_CLASS\_NAME](#SCRIPT_CLASS_NAME)` \| \| \| `protected [LinkedList](https://docs.oracle.com/javase/8/docs/api/java/util/LinkedList.html "LinkedList")<[Closure](../lang/closure "Closure")>` \| `[attributeDelegates](#attributeDelegates)` \| \| \| `protected boolean` \| `[autoRegistrationComplete](#autoRegistrationComplete)` \| \| \| `protected boolean` \| `[autoRegistrationRunning](#autoRegistrationRunning)` \| \| \| `protected [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Closure](../lang/closure "Closure")>` \| `[explicitMethods](#explicitMethods)` \| \| \| `protected [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Closure](../lang/closure "Closure")>` \| `[explicitProperties](#explicitProperties)` \| \| \| `protected [Closure](../lang/closure)` \| `[methodMissingDelegate](#methodMissingDelegate)` \| \| \| `protected [LinkedList](https://docs.oracle.com/javase/8/docs/api/java/util/LinkedList.html "LinkedList")<[Closure](../lang/closure "Closure")>` \| `[postInstantiateDelegates](#postInstantiateDelegates)` \| \| \| `protected [LinkedList](https://docs.oracle.com/javase/8/docs/api/java/util/LinkedList.html "LinkedList")<[Closure](../lang/closure "Closure")>` \| `[postNodeCompletionDelegates](#postNodeCompletionDelegates)` \| \| \| `protected [LinkedList](https://docs.oracle.com/javase/8/docs/api/java/util/LinkedList.html "LinkedList")<[Closure](../lang/closure "Closure")>` \| `[preInstantiateDelegates](#preInstantiateDelegates)` \| \| \| `protected [Closure](../lang/closure)` \| `[propertyMissingDelegate](#propertyMissingDelegate)` \| \| \| `protected [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Set](https://docs.oracle.com/javase/8/docs/api/java/util/Set.html "Set")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>>` \| `[registrationGroup](#registrationGroup)` \| \| \| `protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[registrationGroupName](#registrationGroupName)` \| \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[FactoryBuilderSupport](#FactoryBuilderSupport())()` \| \| `[FactoryBuilderSupport](#FactoryBuilderSupport(boolean))(boolean init)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [Closure](../lang/closure)` \| `[addAttributeDelegate](#addAttributeDelegate(groovy.lang.Closure))([Closure](../lang/closure) attrDelegate)`Add an attribute delegate so it can intercept attributes being set. \| \| \| `public void` \| `[addDisposalClosure](#addDisposalClosure(groovy.lang.Closure))([Closure](../lang/closure) closure)` \| \| \| `public [Closure](../lang/closure)` \| `[addPostInstantiateDelegate](#addPostInstantiateDelegate(groovy.lang.Closure))([Closure](../lang/closure) delegate)`Add a postInstantiate delegate so it can intercept nodes after they are created. \| \| \| `public [Closure](../lang/closure)` \| `[addPostNodeCompletionDelegate](#addPostNodeCompletionDelegate(groovy.lang.Closure))([Closure](../lang/closure) delegate)`Add a nodeCompletion delegate so it can intercept nodes after they done with building. \| \| \| `public [Closure](../lang/closure)` \| `[addPreInstantiateDelegate](#addPreInstantiateDelegate(groovy.lang.Closure))([Closure](../lang/closure) delegate)`Add a preInstantiate delegate so it can intercept nodes before they are created. \| \| \| `public void` \| `[autoRegisterNodes](#autoRegisterNodes())()`Ask the nodes to be registered \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[build](#build(java.lang.Class))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") viewClass)` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[build](#build(groovy.lang.Script))([Script](../lang/script) script)` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[build](#build(java.lang.String,%20groovy.lang.GroovyClassLoader))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") script, [GroovyClassLoader](../lang/groovyclassloader) loader)` \| \| \| `protected boolean` \| `[checkExplicitMethod](#checkExplicitMethod(java.lang.String,%20java.lang.Object,%20groovy.lang.Reference))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args, [Reference](../lang/reference) result)` \| \| \| `public static void` \| `[checkValueIsNull](#checkValueIsNull(java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name)`Throws an exception if value is null. \| \| \| `public static boolean` \| `[checkValueIsType](#checkValueIsType(java.lang.Object,%20java.lang.Object,%20java.lang.Class))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") type)`Checks type of value against builder type \| \| \| `public static boolean` \| `[checkValueIsTypeNotString](#checkValueIsTypeNotString(java.lang.Object,%20java.lang.Object,%20java.lang.Class))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") type)`Checks values against factory's type \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[createNode](#createNode(java.lang.Object,%20java.util.Map,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)`This method is responsible for instantiating a node and configure its properties. \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[dispatchNodeCall](#dispatchNodeCall(java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args)` \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[dispathNodeCall](#dispathNodeCall(java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args)`Use [FactoryBuilderSupport.dispatchNodeCall](factorybuildersupport#dispatchNodeCall(java.lang.Object,%20java.lang.Object) "FactoryBuilderSupport.dispatchNodeCall") instead. \| \| \| `public void` \| `[dispose](#dispose())()` \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Closure](../lang/closure "Closure")>` \| `[getAttributeDelegates](#getAttributeDelegates())()` \| \| \| `public [FactoryBuilderSupport](factorybuildersupport)` \| `[getChildBuilder](#getChildBuilder())()` \| \| \| `public [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")>` \| `[getContext](#getContext())()` Returns: the context of the current node. \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getContextAttribute](#getContextAttribute(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") key)` \| \| \| `protected [LinkedList](https://docs.oracle.com/javase/8/docs/api/java/util/LinkedList.html "LinkedList")<[Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")>>` \| `[getContexts](#getContexts())()` Returns: the stack of available contexts. \| \| \| `protected [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")>` \| `[getContinuationData](#getContinuationData())()`Stores the thread local states in a Map that can be passed across threads \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getCurrent](#getCurrent())()` Returns: the current node being built. \| \| \| `public [FactoryBuilderSupport](factorybuildersupport)` \| `[getCurrentBuilder](#getCurrentBuilder())()` Returns: the builder that built the current node. \| \| \| `public [Factory](factory)` \| `[getCurrentFactory](#getCurrentFactory())()` Returns: the factory that built the current node. \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getCurrentName](#getCurrentName())()` Returns: the factory of the parent of the current node. \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Closure](../lang/closure "Closure")>` \| `[getDisposalClosures](#getDisposalClosures())()` \| \| \| `public [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Closure](../lang/closure "Closure")>` \| `[getExplicitMethods](#getExplicitMethods())()` Returns: the explicit methods map (Unmodifiable Map). \| \| \| `public [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Closure](../lang/closure "Closure")>` \| `[getExplicitProperties](#getExplicitProperties())()` Returns: the explicit properties map (Unmodifiable Map). \| \| \| `public [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Factory](factory "Factory")>` \| `[getFactories](#getFactories())()` Returns: the factory map (Unmodifiable Map). \| \| \| `public [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Closure](../lang/closure "Closure")>` \| `[getLocalExplicitMethods](#getLocalExplicitMethods())()` Returns: the explicit methods map (Unmodifiable Map). \| \| \| `public [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Closure](../lang/closure "Closure")>` \| `[getLocalExplicitProperties](#getLocalExplicitProperties())()` Returns: the explicit properties map (Unmodifiable Map). \| \| \| `public [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Factory](factory "Factory")>` \| `[getLocalFactories](#getLocalFactories())()` Returns: the factory map (Unmodifiable Map). \| \| \| `public [Closure](../lang/closure)` \| `[getMethodMissingDelegate](#getMethodMissingDelegate())()` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getName](#getName(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName)`A hook to allow names to be converted into some other object such as a QName in XML or ObjectName in JMX. \| \| \| `public [Closure](../lang/closure)` \| `[getNameMappingClosure](#getNameMappingClosure())()` \| \| \| `public [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")` \| `[getParentContext](#getParentContext())()` Returns: the context of the parent of the current node. \| \| \| `public [Factory](factory)` \| `[getParentFactory](#getParentFactory())()` Returns: the factory of the parent of the current node. \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getParentName](#getParentName())()` Returns: the name of the parent of the current node. \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getParentNode](#getParentNode())()` Returns: the node of the parent of the current node. \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Closure](../lang/closure "Closure")>` \| `[getPostInstantiateDelegates](#getPostInstantiateDelegates())()` \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Closure](../lang/closure "Closure")>` \| `[getPostNodeCompletionDelegates](#getPostNodeCompletionDelegates())()` \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Closure](../lang/closure "Closure")>` \| `[getPreInstantiateDelegates](#getPreInstantiateDelegates())()` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getProperty](#getProperty(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") property)`Overloaded to make variables appear as bean properties or via the subscript operator \| \| \| `public [Closure](../lang/closure)` \| `[getPropertyMissingDelegate](#getPropertyMissingDelegate())()` \| \| \| `protected [FactoryBuilderSupport](factorybuildersupport)` \| `[getProxyBuilder](#getProxyBuilder())()`Proxy builders are useful for changing the building context, thus enabling mix & match builders. \| \| \| `public [Set](https://docs.oracle.com/javase/8/docs/api/java/util/Set.html "Set")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>` \| `[getRegistrationGroupItems](#getRegistrationGroupItems(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") group)` \| \| \| `public [Set](https://docs.oracle.com/javase/8/docs/api/java/util/Set.html "Set")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>` \| `[getRegistrationGroups](#getRegistrationGroups())()` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getVariable](#getVariable(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name)` Parameters: `name` - the name of the variable to lookup \| \| \| `public [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")` \| `[getVariables](#getVariables())()` \| \| \| `protected void` \| `[handleNodeAttributes](#handleNodeAttributes(java.lang.Object,%20java.util.Map))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)`Assigns any existing properties to the node. \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[invokeMethod](#invokeMethod(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName)`Convenience method when no arguments are required \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[invokeMethod](#invokeMethod(java.lang.String,%20java.lang.Object))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args)` \| \| \| `protected void` \| `[newContext](#newContext())()`Pushes a new context on the stack. \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") properties)` \| \| \| `protected void` \| `[nodeCompleted](#nodeCompleted(java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node)`A hook to allow nodes to be processed once they have had all of their children applied. \| \| \| `protected [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")>` \| `[popContext](#popContext())()`Removes the last context from the stack. \| \| \| `protected void` \| `[postInstantiate](#postInstantiate(java.lang.Object,%20java.util.Map,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node)`A hook after the factory creates the node and before attributes are set. \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[postNodeCompletion](#postNodeCompletion(java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node)`A hook to allow nodes to be processed once they have had all of their children applied and allows the actual node object that represents the Markup element to be changed. \| \| \| `protected void` \| `[preInstantiate](#preInstantiate(java.lang.Object,%20java.util.Map,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)`A hook before the factory creates the node. \| \| \| `public void` \| `[registerBeanFactory](#registerBeanFactory(java.lang.String,%20java.lang.Class))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") theName, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") beanClass)`Registers a factory for a JavaBean. \| \| \| `public void` \| `[registerBeanFactory](#registerBeanFactory(java.lang.String,%20java.lang.String,%20java.lang.Class))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") theName, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") groupName, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") beanClass)`Registers a factory for a JavaBean. \| \| \| `public void` \| `[registerExplicitMethod](#registerExplicitMethod(java.lang.String,%20groovy.lang.Closure))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Closure](../lang/closure) closure)` \| \| \| `public void` \| `[registerExplicitMethod](#registerExplicitMethod(java.lang.String,%20java.lang.String,%20groovy.lang.Closure))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") groupName, [Closure](../lang/closure) closure)` \| \| \| `public void` \| `[registerExplicitProperty](#registerExplicitProperty(java.lang.String,%20groovy.lang.Closure,%20groovy.lang.Closure))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Closure](../lang/closure) getter, [Closure](../lang/closure) setter)` \| \| \| `public void` \| `[registerExplicitProperty](#registerExplicitProperty(java.lang.String,%20java.lang.String,%20groovy.lang.Closure,%20groovy.lang.Closure))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") groupName, [Closure](../lang/closure) getter, [Closure](../lang/closure) setter)` \| \| \| `public void` \| `[registerFactory](#registerFactory(java.lang.String,%20groovy.util.Factory))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Factory](factory) factory)`Registers a factory for a node name. \| \| \| `public void` \| `[registerFactory](#registerFactory(java.lang.String,%20java.lang.String,%20groovy.util.Factory))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") groupName, [Factory](factory) factory)`Registers a factory for a node name. \| \| \| `public void` \| `[removeAttributeDelegate](#removeAttributeDelegate(groovy.lang.Closure))([Closure](../lang/closure) attrDelegate)`Remove the most recently added instance of the attribute delegate. \| \| \| `public void` \| `[removePostInstantiateDelegate](#removePostInstantiateDelegate(groovy.lang.Closure))([Closure](../lang/closure) delegate)`Remove the most recently added instance of the postInstantiate delegate. \| \| \| `public void` \| `[removePostNodeCompletionDelegate](#removePostNodeCompletionDelegate(groovy.lang.Closure))([Closure](../lang/closure) delegate)`Remove the most recently added instance of the nodeCompletion delegate. \| \| \| `public void` \| `[removePreInstantiateDelegate](#removePreInstantiateDelegate(groovy.lang.Closure))([Closure](../lang/closure) delegate)`Remove the most recently added instance of the preInstantiate delegate. \| \| \| `protected void` \| `[reset](#reset())()`Clears the context stack. \| \| \| `protected [Closure](../lang/closure)` \| `[resolveExplicitMethod](#resolveExplicitMethod(java.lang.String,%20java.lang.Object))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args)`This is a hook for subclasses to plugin a custom strategy for mapping names to explicit methods. \| \| \| `protected [Closure](../lang/closure "Closure")[]` \| `[resolveExplicitProperty](#resolveExplicitProperty(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") propertyName)`This is a hook for subclasses to plugin a custom strategy for mapping names to property methods. \| \| \| `protected [Factory](factory)` \| `[resolveFactory](#resolveFactory(java.lang.Object,%20java.util.Map,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)`This is a hook for subclasses to plugin a custom strategy for mapping names to factories. \| \| \| `protected void` \| `[restoreFromContinuationData](#restoreFromContinuationData(Map))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")> data)`Restores the state of the current builder to the same state as an older build. \| \| \| `protected void` \| `[setClosureDelegate](#setClosureDelegate(groovy.lang.Closure,%20java.lang.Object))([Closure](../lang/closure) closure, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node)`A strategy method to allow derived builders to use builder-trees and switch in different kinds of builders. \| \| \| `public void` \| `[setMethodMissingDelegate](#setMethodMissingDelegate(groovy.lang.Closure))([Closure](../lang/closure) delegate)` \| \| \| `public void` \| `[setNameMappingClosure](#setNameMappingClosure(groovy.lang.Closure))([Closure](../lang/closure) nameMappingClosure)` \| \| \| `protected void` \| `[setNodeAttributes](#setNodeAttributes(java.lang.Object,%20java.util.Map))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)`Maps attributes key/values to properties on node. \| \| \| `protected void` \| `[setParent](#setParent(java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child)`Strategy method to establish parent/child relationships. \| \| \| `public void` \| `[setProperty](#setProperty(java.lang.String,%20java.lang.Object))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") property, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newValue)`Overloaded to make variables appear as bean properties or via the subscript operator \| \| \| `public void` \| `[setPropertyMissingDelegate](#setPropertyMissingDelegate(groovy.lang.Closure))([Closure](../lang/closure) delegate)` \| \| \| `protected void` \| `[setProxyBuilder](#setProxyBuilder(groovy.util.FactoryBuilderSupport))([FactoryBuilderSupport](factorybuildersupport) proxyBuilder)`Sets the builder to be used as a proxy. \| \| \| `public void` \| `[setVariable](#setVariable(java.lang.String,%20java.lang.Object))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)`Sets the value of the given variable \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[withBuilder](#withBuilder(groovy.util.FactoryBuilderSupport,%20groovy.lang.Closure))([FactoryBuilderSupport](factorybuildersupport) builder, [Closure](../lang/closure) closure)`Switches the builder's proxyBuilder during the execution of a closure. \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[withBuilder](#withBuilder(groovy.util.FactoryBuilderSupport,%20java.lang.String,%20groovy.lang.Closure))([FactoryBuilderSupport](factorybuildersupport) builder, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Closure](../lang/closure) closure)`Switches the builder's proxyBuilder during the execution of a closure. \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[withBuilder](#withBuilder(java.util.Map,%20groovy.util.FactoryBuilderSupport,%20java.lang.String,%20groovy.lang.Closure))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes, [FactoryBuilderSupport](factorybuildersupport) builder, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Closure](../lang/closure) closure)`Switches the builder's proxyBuilder during the execution of a closure. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Binding](../lang/binding)` \| `[getProperty](../lang/binding#getProperty(java.lang.String)), [getVariable](../lang/binding#getVariable(java.lang.String)), [getVariables](../lang/binding#getVariables()), [hasVariable](../lang/binding#hasVariable(java.lang.String)), [removeVariable](../lang/binding#removeVariable(java.lang.String)), [setProperty](../lang/binding#setProperty(java.lang.String,%20java.lang.Object)), [setVariable](../lang/binding#setVariable(java.lang.String,%20java.lang.Object))` \| \| `class [GroovyObjectSupport](../lang/groovyobjectsupport)` \| `[getMetaClass](../lang/groovyobjectsupport#getMetaClass()), [setMetaClass](../lang/groovyobjectsupport#setMetaClass(groovy.lang.MetaClass))` \| Field Detail ------------ ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") CHILD\_BUILDER ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") CURRENT\_BUILDER ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") CURRENT\_FACTORY ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") CURRENT\_NAME ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") CURRENT\_NODE ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") OWNER ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") PARENT\_BUILDER ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") PARENT\_CONTEXT ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") PARENT\_FACTORY ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") PARENT\_NAME ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") PARENT\_NODE ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") SCRIPT\_CLASS\_NAME ### protected [LinkedList](https://docs.oracle.com/javase/8/docs/api/java/util/LinkedList.html "LinkedList")<[Closure](../lang/closure "Closure")> attributeDelegates ### protected boolean autoRegistrationComplete ### protected boolean autoRegistrationRunning ### protected [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Closure](../lang/closure "Closure")> explicitMethods ### protected [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Closure](../lang/closure "Closure")> explicitProperties ### protected [Closure](../lang/closure) methodMissingDelegate ### protected [LinkedList](https://docs.oracle.com/javase/8/docs/api/java/util/LinkedList.html "LinkedList")<[Closure](../lang/closure "Closure")> postInstantiateDelegates ### protected [LinkedList](https://docs.oracle.com/javase/8/docs/api/java/util/LinkedList.html "LinkedList")<[Closure](../lang/closure "Closure")> postNodeCompletionDelegates ### protected [LinkedList](https://docs.oracle.com/javase/8/docs/api/java/util/LinkedList.html "LinkedList")<[Closure](../lang/closure "Closure")> preInstantiateDelegates ### protected [Closure](../lang/closure) propertyMissingDelegate ### protected [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Set](https://docs.oracle.com/javase/8/docs/api/java/util/Set.html "Set")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>> registrationGroup ### protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") registrationGroupName Constructor Detail ------------------ ### public FactoryBuilderSupport() ### public FactoryBuilderSupport(boolean init) Method Detail ------------- ### public [Closure](../lang/closure) addAttributeDelegate([Closure](../lang/closure) attrDelegate) Add an attribute delegate so it can intercept attributes being set. Attribute delegates are fired in a FILO pattern, so that nested delegates get first crack. Parameters: `attrDelegate` - the closure to be called Returns: attrDelegate ### public void addDisposalClosure([Closure](../lang/closure) closure) ### public [Closure](../lang/closure) addPostInstantiateDelegate([Closure](../lang/closure) delegate) Add a postInstantiate delegate so it can intercept nodes after they are created. PostInstantiate delegates are fired in a FILO pattern, so that nested delegates get first crack. Parameters: `delegate` - the closure to invoke Returns: delegate ### public [Closure](../lang/closure) addPostNodeCompletionDelegate([Closure](../lang/closure) delegate) Add a nodeCompletion delegate so it can intercept nodes after they done with building. NodeCompletion delegates are fired in a FILO pattern, so that nested delegates get first crack. Parameters: `delegate` - the closure to invoke Returns: delegate ### public [Closure](../lang/closure) addPreInstantiateDelegate([Closure](../lang/closure) delegate) Add a preInstantiate delegate so it can intercept nodes before they are created. PreInstantiate delegates are fired in a FILO pattern, so that nested delegates get first crack. Parameters: `delegate` - the closure to invoke Returns: delegate ### public void autoRegisterNodes() Ask the nodes to be registered ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") build([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") viewClass) ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") build([Script](../lang/script) script) ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") build([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") script, [GroovyClassLoader](../lang/groovyclassloader) loader) ### protected boolean checkExplicitMethod([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args, [Reference](../lang/reference) result) ### public static void checkValueIsNull([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name) Throws an exception if value is null. Parameters: `value` - the node's value `name` - the node's name ### public static boolean checkValueIsType([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") type) Checks type of value against builder type Parameters: `value` - the node's value `name` - the node's name `type` - a Class that may be assignable to the value's class Returns: true if type is assignable to the value's class, false if value is null. ### public static boolean checkValueIsTypeNotString([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") type) Checks values against factory's type Parameters: `value` - the node's value `name` - the node's name `type` - a Class that may be assignable to the value's class Returns: Returns true if type is assignable to the value's class, false if value is null or a String. ### protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") createNode([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) This method is responsible for instantiating a node and configure its properties. Parameters: `name` - the name of the node `attributes` - the attributes for the node `value` - the value arguments for the node Returns: the object return from the factory ### protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") dispatchNodeCall([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args) ### @[Deprecated](https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html "Deprecated") protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") dispathNodeCall([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args) Use [FactoryBuilderSupport.dispatchNodeCall](factorybuildersupport#dispatchNodeCall(java.lang.Object,%20java.lang.Object) "FactoryBuilderSupport.dispatchNodeCall") instead. ### public void dispose() ### public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Closure](../lang/closure "Closure")> getAttributeDelegates() ### public [FactoryBuilderSupport](factorybuildersupport) getChildBuilder() ### public [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")> getContext() Returns: the context of the current node. ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getContextAttribute([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") key) ### protected [LinkedList](https://docs.oracle.com/javase/8/docs/api/java/util/LinkedList.html "LinkedList")<[Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")>> getContexts() Returns: the stack of available contexts. ### protected [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")> getContinuationData() Stores the thread local states in a Map that can be passed across threads Returns: the map ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getCurrent() Returns: the current node being built. ### public [FactoryBuilderSupport](factorybuildersupport) getCurrentBuilder() Returns: the builder that built the current node. ### public [Factory](factory) getCurrentFactory() Returns: the factory that built the current node. ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getCurrentName() Returns: the factory of the parent of the current node. ### public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Closure](../lang/closure "Closure")> getDisposalClosures() ### public [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Closure](../lang/closure "Closure")> getExplicitMethods() Returns: the explicit methods map (Unmodifiable Map). ### public [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Closure](../lang/closure "Closure")> getExplicitProperties() Returns: the explicit properties map (Unmodifiable Map). ### public [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Factory](factory "Factory")> getFactories() Returns: the factory map (Unmodifiable Map). ### public [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Closure](../lang/closure "Closure")> getLocalExplicitMethods() Returns: the explicit methods map (Unmodifiable Map). ### public [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Closure](../lang/closure "Closure")> getLocalExplicitProperties() Returns: the explicit properties map (Unmodifiable Map). ### public [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Factory](factory "Factory")> getLocalFactories() Returns: the factory map (Unmodifiable Map). ### public [Closure](../lang/closure) getMethodMissingDelegate() ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getName([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName) A hook to allow names to be converted into some other object such as a QName in XML or ObjectName in JMX. Parameters: `methodName` - the name of the desired method Returns: the object representing the name ### public [Closure](../lang/closure) getNameMappingClosure() ### public [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") getParentContext() Returns: the context of the parent of the current node. ### public [Factory](factory) getParentFactory() Returns: the factory of the parent of the current node. ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getParentName() Returns: the name of the parent of the current node. ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getParentNode() Returns: the node of the parent of the current node. ### public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Closure](../lang/closure "Closure")> getPostInstantiateDelegates() ### public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Closure](../lang/closure "Closure")> getPostNodeCompletionDelegates() ### public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Closure](../lang/closure "Closure")> getPreInstantiateDelegates() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getProperty([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") property) Overloaded to make variables appear as bean properties or via the subscript operator ### public [Closure](../lang/closure) getPropertyMissingDelegate() ### protected [FactoryBuilderSupport](factorybuildersupport) getProxyBuilder() Proxy builders are useful for changing the building context, thus enabling mix & match builders. Returns: the current builder that serves as a proxy. ### public [Set](https://docs.oracle.com/javase/8/docs/api/java/util/Set.html "Set")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> getRegistrationGroupItems([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") group) ### public [Set](https://docs.oracle.com/javase/8/docs/api/java/util/Set.html "Set")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> getRegistrationGroups() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getVariable([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name) Parameters: `name` - the name of the variable to lookup Returns: the variable value ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") getVariables() ### protected void handleNodeAttributes([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) Assigns any existing properties to the node. It will call attributeDelegates before passing control to the factory that built the node. Parameters: `node` - the object returned by tne node factory `attributes` - the attributes for the node ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") invokeMethod([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName) Convenience method when no arguments are required Parameters: `methodName` - the name of the method to invoke Returns: the result of the call ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") invokeMethod([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args) ### protected void newContext() Pushes a new context on the stack. ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") properties) ### protected void nodeCompleted([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node) A hook to allow nodes to be processed once they have had all of their children applied. Parameters: `node` - the current node being processed `parent` - the parent of the node being processed ### protected [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")> popContext() Removes the last context from the stack. Returns: the content just removed ### protected void postInstantiate([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node) A hook after the factory creates the node and before attributes are set. It will call any registered postInstantiateDelegates, if you override this method be sure to call this impl somewhere in your code. Parameters: `name` - the name of the node `attributes` - the attributes for the node `node` - the object created by the node factory ### protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") postNodeCompletion([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node) A hook to allow nodes to be processed once they have had all of their children applied and allows the actual node object that represents the Markup element to be changed. It will call any registered postNodeCompletionDelegates, if you override this method be sure to call this impl at the end of your code. Parameters: `node` - the current node being processed `parent` - the parent of the node being processed Returns: the node, possibly new, that represents the markup element ### protected void preInstantiate([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) A hook before the factory creates the node. It will call any registered preInstantiateDelegates, if you override this method be sure to call this impl somewhere in your code. Parameters: `name` - the name of the node `attributes` - the attributes of the node `value` - the value argument(s) of the node ### public void registerBeanFactory([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") theName, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") beanClass) Registers a factory for a JavaBean. The JavaBean class should have a no-args constructor. Parameters: `theName` - name of the node `beanClass` - the factory to handle the name ### public void registerBeanFactory([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") theName, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") groupName, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") beanClass) Registers a factory for a JavaBean. The JavaBean class should have a no-args constructor. Parameters: `theName` - name of the node `groupName` - thr group to register this node in `beanClass` - the factory to handle the name ### public void registerExplicitMethod([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Closure](../lang/closure) closure) ### public void registerExplicitMethod([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") groupName, [Closure](../lang/closure) closure) ### public void registerExplicitProperty([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Closure](../lang/closure) getter, [Closure](../lang/closure) setter) ### public void registerExplicitProperty([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") groupName, [Closure](../lang/closure) getter, [Closure](../lang/closure) setter) ### public void registerFactory([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Factory](factory) factory) Registers a factory for a node name. Parameters: `name` - the name of the node `factory` - the factory to return the values ### public void registerFactory([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") groupName, [Factory](factory) factory) Registers a factory for a node name. Parameters: `name` - the name of the node `groupName` - thr group to register this node in `factory` - the factory to return the values ### public void removeAttributeDelegate([Closure](../lang/closure) attrDelegate) Remove the most recently added instance of the attribute delegate. Parameters: `attrDelegate` - the instance of the closure to be removed ### public void removePostInstantiateDelegate([Closure](../lang/closure) delegate) Remove the most recently added instance of the postInstantiate delegate. Parameters: `delegate` - the closure to invoke ### public void removePostNodeCompletionDelegate([Closure](../lang/closure) delegate) Remove the most recently added instance of the nodeCompletion delegate. Parameters: `delegate` - the closure to be removed ### public void removePreInstantiateDelegate([Closure](../lang/closure) delegate) Remove the most recently added instance of the preInstantiate delegate. Parameters: `delegate` - the closure to invoke ### protected void reset() Clears the context stack. ### @[SuppressWarnings](https://docs.oracle.com/javase/8/docs/api/java/lang/SuppressWarnings.html "SuppressWarnings")({"UnusedDeclaration"}) protected [Closure](../lang/closure) resolveExplicitMethod([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args) This is a hook for subclasses to plugin a custom strategy for mapping names to explicit methods. Parameters: `methodName` - the name of the explicit method `args` - the arguments for the method Returns: the closure for the matched explicit method. ### protected [Closure](../lang/closure "Closure")[] resolveExplicitProperty([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") propertyName) This is a hook for subclasses to plugin a custom strategy for mapping names to property methods. Parameters: `propertyName` - the name of the explicit method Returns: the get and set closures (in that order) for the matched explicit property. ### protected [Factory](factory) resolveFactory([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) This is a hook for subclasses to plugin a custom strategy for mapping names to factories. Parameters: `name` - the name of the factory `attributes` - the attributes from the node `value` - value arguments from te node Returns: the Factory associated with name. ### protected void restoreFromContinuationData([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")> data) Restores the state of the current builder to the same state as an older build. Caution, this will destroy rather than merge the current build context if there is any, Parameters: `data` - the data retrieved from a compatible getContinuationData call ### @[SuppressWarnings](https://docs.oracle.com/javase/8/docs/api/java/lang/SuppressWarnings.html "SuppressWarnings")({"UnusedDeclaration"}) protected void setClosureDelegate([Closure](../lang/closure) closure, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node) A strategy method to allow derived builders to use builder-trees and switch in different kinds of builders. This method should call the setDelegate() method on the closure which by default passes in this but if node is-a builder we could pass that in instead (or do something wacky too) Parameters: `closure` - the closure on which to call setDelegate() `node` - the node value that we've just created, which could be a builder ### public void setMethodMissingDelegate([Closure](../lang/closure) delegate) ### public void setNameMappingClosure([Closure](../lang/closure) nameMappingClosure) ### protected void setNodeAttributes([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) Maps attributes key/values to properties on node. Parameters: `node` - the object from the node `attributes` - the attributes to be set ### protected void setParent([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child) Strategy method to establish parent/child relationships. Parameters: `parent` - the object from the parent node `child` - the object from the child node ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void setProperty([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") property, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newValue) Overloaded to make variables appear as bean properties or via the subscript operator ### public void setPropertyMissingDelegate([Closure](../lang/closure) delegate) ### protected void setProxyBuilder([FactoryBuilderSupport](factorybuildersupport) proxyBuilder) Sets the builder to be used as a proxy. Parameters: `proxyBuilder` - the new proxy ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void setVariable([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) Sets the value of the given variable Parameters: `name` - the name of the variable to set `value` - the new value for the given variable ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") withBuilder([FactoryBuilderSupport](factorybuildersupport) builder, [Closure](../lang/closure) closure) Switches the builder's proxyBuilder during the execution of a closure. This is useful to temporary change the building context to another builder without the need for a contrived setup. It will also take care of restoring the previous proxyBuilder when the execution finishes, even if an exception was thrown from inside the closure. throws: RuntimeException - any exception the closure might have thrown during execution. Parameters: `builder` - the temporary builder to switch to as proxyBuilder. `closure` - the closure to be executed under the temporary builder. Returns: the execution result of the closure. ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") withBuilder([FactoryBuilderSupport](factorybuildersupport) builder, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Closure](../lang/closure) closure) Switches the builder's proxyBuilder during the execution of a closure. This is useful to temporary change the building context to another builder without the need for a contrived setup. It will also take care of restoring the previous proxyBuilder when the execution finishes, even if an exception was thrown from inside the closure. Additionally it will use the closure's result as the value for the node identified by 'name'. throws: RuntimeException - any exception the closure might have thrown during execution. Parameters: `builder` - the temporary builder to switch to as proxyBuilder. `name` - the node to build on the 'parent' builder. `closure` - the closure to be executed under the temporary builder. Returns: a node that responds to value of name with the closure's result as its value. ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") withBuilder([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes, [FactoryBuilderSupport](factorybuildersupport) builder, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Closure](../lang/closure) closure) Switches the builder's proxyBuilder during the execution of a closure. This is useful to temporary change the building context to another builder without the need for a contrived setup. It will also take care of restoring the previous proxyBuilder when the execution finishes, even if an exception was thrown from inside the closure. Additionally it will use the closure's result as the value for the node identified by 'name' and assign any attributes that might have been set. throws: RuntimeException - any exception the closure might have thrown during execution. Parameters: `attributes` - additional properties for the node on the parent builder. `builder` - the temporary builder to switch to as proxyBuilder. `name` - the node to build on the 'parent' builder. `closure` - the closure to be executed under the temporary builder. Returns: a node that responds to value of name with the closure's result as its value.	programming_docs
groovy [Java] Class ObservableList [Java] Class ObservableList =========================== * groovy.util.ObservableList All Implemented Interfaces and Traits: [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") ``` public class ObservableList extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") implements [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") ``` List decorator that will trigger PropertyChangeEvents when a value changes. An optional Closure may be specified and will work as a filter, if it returns true the property will trigger an event (if the value indeed changed), otherwise it won't. The Closure may receive 1 or 2 parameters, the single one being the value, the other one both the key and value, for example: ``` // skip all properties whose value is a closure def map = new ObservableList( {!(it instanceof Closure)} ) // skip all properties whose name matches a regex def map = new ObservableList( { name, value -> !(name =˜ /[A-Z+]/) } ) ``` The current implementation will trigger specialized events in the following scenarios, you need not register a different listener as those events extend from PropertyChangeEvent * ObservableList.ElementAddedEvent - a new element is added to the list * ObservableList.ElementRemovedEvent - an element is removed from the list * ObservableList.ElementUpdatedEvent - an element changes value (same as regular PropertyChangeEvent) * ObservableList.ElementClearedEvent - all elements have been removed from the list * ObservableList.MultiElementAddedEvent - triggered by calling list.addAll() * ObservableList.MultiElementRemovedEvent - triggered by calling list.removeAll()/list.retainAll() Bound properties * content - read-only. * size - read-only. Nested Class Summary -------------------- Nested classes \| Modifiers \| Name \| Description \| \| `enum` \| `[ObservableList.ChangeType](observablelist.changetype)` \| \| \| `static class` \| `[ObservableList.ElementAddedEvent](observablelist.elementaddedevent)` \| \| \| `static class` \| `[ObservableList.ElementClearedEvent](observablelist.elementclearedevent)` \| \| \| `static class` \| `[ObservableList.ElementEvent](observablelist.elementevent)` \| \| \| `static class` \| `[ObservableList.ElementRemovedEvent](observablelist.elementremovedevent)` \| \| \| `static class` \| `[ObservableList.ElementUpdatedEvent](observablelist.elementupdatedevent)` \| \| \| `static class` \| `[ObservableList.MultiElementAddedEvent](observablelist.multielementaddedevent)` \| \| \| `static class` \| `[ObservableList.MultiElementRemovedEvent](observablelist.multielementremovedevent)` \| \| \| `protected class` \| `[ObservableList.ObservableIterator](observablelist.observableiterator)` \| \| \| `protected class` \| `[ObservableList.ObservableListIterator](observablelist.observablelistiterator)` \| \| Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[CONTENT\_PROPERTY](#CONTENT_PROPERTY)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[SIZE\_PROPERTY](#SIZE_PROPERTY)` \| \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[ObservableList](#ObservableList())()` \| \| `[ObservableList](#ObservableList(java.util.List))([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") delegate)` \| \| `[ObservableList](#ObservableList(groovy.lang.Closure))([Closure](../lang/closure) test)` \| \| `[ObservableList](#ObservableList(java.util.List,%20groovy.lang.Closure))([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") delegate, [Closure](../lang/closure) test)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public void` \| `[add](#add(int,%20java.lang.Object))(int index, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") element)` \| \| \| `public boolean` \| `[add](#add(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o)` \| \| \| `public boolean` \| `[addAll](#addAll(java.util.Collection))([Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection") c)` \| \| \| `public boolean` \| `[addAll](#addAll(int,%20java.util.Collection))(int index, [Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection") c)` \| \| \| `public void` \| `[addPropertyChangeListener](#addPropertyChangeListener(java.beans.PropertyChangeListener))([PropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html "PropertyChangeListener") listener)` \| \| \| `public void` \| `[addPropertyChangeListener](#addPropertyChangeListener(java.lang.String,%20java.beans.PropertyChangeListener))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") propertyName, [PropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html "PropertyChangeListener") listener)` \| \| \| `public void` \| `[clear](#clear())()` \| \| \| `public boolean` \| `[contains](#contains(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o)` \| \| \| `public boolean` \| `[containsAll](#containsAll(java.util.Collection))([Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection") c)` \| \| \| `public boolean` \| `[equals](#equals(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o)` \| \| \| `protected void` \| `[fireElementAddedEvent](#fireElementAddedEvent(int,%20java.lang.Object))(int index, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") element)` \| \| \| `protected void` \| `[fireElementClearedEvent](#fireElementClearedEvent(java.util.List))([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") values)` \| \| \| `protected void` \| `[fireElementEvent](#fireElementEvent(ElementEvent))([ElementEvent](../../elementevent) event)` \| \| \| `protected void` \| `[fireElementRemovedEvent](#fireElementRemovedEvent(int,%20java.lang.Object))(int index, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") element)` \| \| \| `protected void` \| `[fireElementUpdatedEvent](#fireElementUpdatedEvent(int,%20java.lang.Object,%20java.lang.Object))(int index, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") oldValue, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newValue)` \| \| \| `protected void` \| `[fireMultiElementAddedEvent](#fireMultiElementAddedEvent(int,%20java.util.List))(int index, [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") values)` \| \| \| `protected void` \| `[fireMultiElementRemovedEvent](#fireMultiElementRemovedEvent(java.util.List))([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") values)` \| \| \| `protected void` \| `[fireSizeChangedEvent](#fireSizeChangedEvent(int,%20int))(int oldValue, int newValue)` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[get](#get(int))(int index)` \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")` \| `[getContent](#getContent())()` \| \| \| `protected [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")` \| `[getDelegateList](#getDelegateList())()` \| \| \| `public [PropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html "PropertyChangeListener")[]` \| `[getPropertyChangeListeners](#getPropertyChangeListeners())()` \| \| \| `public [PropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html "PropertyChangeListener")[]` \| `[getPropertyChangeListeners](#getPropertyChangeListeners(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") propertyName)` \| \| \| `public int` \| `[getSize](#getSize())()` \| \| \| `protected [Closure](../lang/closure)` \| `[getTest](#getTest())()` \| \| \| `public boolean` \| `[hasListeners](#hasListeners(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") propertyName)` \| \| \| `public int` \| `[hashCode](#hashCode())()` \| \| \| `public int` \| `[indexOf](#indexOf(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o)` \| \| \| `public boolean` \| `[isEmpty](#isEmpty())()` \| \| \| `public [Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html "Iterator")` \| `[iterator](#iterator())()` \| \| \| `public int` \| `[lastIndexOf](#lastIndexOf(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o)` \| \| \| `public [ListIterator](https://docs.oracle.com/javase/8/docs/api/java/util/ListIterator.html "ListIterator")` \| `[listIterator](#listIterator())()` \| \| \| `public [ListIterator](https://docs.oracle.com/javase/8/docs/api/java/util/ListIterator.html "ListIterator")` \| `[listIterator](#listIterator(int))(int index)` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[remove](#remove(int))(int index)` \| \| \| `public boolean` \| `[remove](#remove(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o)` \| \| \| `public boolean` \| `[removeAll](#removeAll(java.util.Collection))([Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection") c)` \| \| \| `public void` \| `[removePropertyChangeListener](#removePropertyChangeListener(java.beans.PropertyChangeListener))([PropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html "PropertyChangeListener") listener)` \| \| \| `public void` \| `[removePropertyChangeListener](#removePropertyChangeListener(java.lang.String,%20java.beans.PropertyChangeListener))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") propertyName, [PropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html "PropertyChangeListener") listener)` \| \| \| `public boolean` \| `[retainAll](#retainAll(java.util.Collection))([Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection") c)` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[set](#set(int,%20java.lang.Object))(int index, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") element)` \| \| \| `public int` \| `[size](#size())()` \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")` \| `[subList](#subList(int,%20int))(int fromIndex, int toIndex)` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[]` \| `[toArray](#toArray())()` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[]` \| `[toArray](#toArray(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] a)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Field Detail ------------ ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") CONTENT\_PROPERTY ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") SIZE\_PROPERTY Constructor Detail ------------------ ### public ObservableList() ### public ObservableList([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") delegate) ### public ObservableList([Closure](../lang/closure) test) ### public ObservableList([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") delegate, [Closure](../lang/closure) test) Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void add(int index, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") element) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean add([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean addAll([Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection") c) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean addAll(int index, [Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection") c) ### public void addPropertyChangeListener([PropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html "PropertyChangeListener") listener) ### public void addPropertyChangeListener([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") propertyName, [PropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html "PropertyChangeListener") listener) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void clear() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean contains([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean containsAll([Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection") c) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean equals([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o) ### protected void fireElementAddedEvent(int index, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") element) ### protected void fireElementClearedEvent([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") values) ### protected void fireElementEvent([ElementEvent](../../elementevent) event) ### protected void fireElementRemovedEvent(int index, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") element) ### protected void fireElementUpdatedEvent(int index, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") oldValue, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newValue) ### protected void fireMultiElementAddedEvent(int index, [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") values) ### protected void fireMultiElementRemovedEvent([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") values) ### protected void fireSizeChangedEvent(int oldValue, int newValue) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") get(int index) ### public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") getContent() ### protected [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") getDelegateList() ### public [PropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html "PropertyChangeListener")[] getPropertyChangeListeners() ### public [PropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html "PropertyChangeListener")[] getPropertyChangeListeners([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") propertyName) ### public int getSize() ### protected [Closure](../lang/closure) getTest() ### public boolean hasListeners([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") propertyName) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public int hashCode() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public int indexOf([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean isEmpty() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html "Iterator") iterator() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public int lastIndexOf([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ListIterator](https://docs.oracle.com/javase/8/docs/api/java/util/ListIterator.html "ListIterator") listIterator() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ListIterator](https://docs.oracle.com/javase/8/docs/api/java/util/ListIterator.html "ListIterator") listIterator(int index) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") remove(int index) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean remove([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean removeAll([Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection") c) ### public void removePropertyChangeListener([PropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html "PropertyChangeListener") listener) ### public void removePropertyChangeListener([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") propertyName, [PropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html "PropertyChangeListener") listener) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean retainAll([Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection") c) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") set(int index, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") element) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public int size() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") subList(int fromIndex, int toIndex) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] toArray() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] toArray([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] a)	programming_docs
groovy [Java] Class ObjectGraphBuilder [Java] Class ObjectGraphBuilder =============================== * groovy.util.ObjectGraphBuilder ``` public class ObjectGraphBuilder extends [FactoryBuilderSupport](factorybuildersupport "FactoryBuilderSupport") ``` A builder for creating object graphs. Each node defines the class to be created and the property on its parent (if any) at the same time. Nested Class Summary -------------------- Nested classes \| Modifiers \| Name \| Description \| \| `interface` \| `[ObjectGraphBuilder.ChildPropertySetter](objectgraphbuilder.childpropertysetter)` \| Strategy for setting a child node on its parent. \| \| `interface` \| `[ObjectGraphBuilder.ClassNameResolver](objectgraphbuilder.classnameresolver)` \| Strategy for resolving a classname. \| \| `static class` \| `[ObjectGraphBuilder.DefaultChildPropertySetter](objectgraphbuilder.defaultchildpropertysetter)` \| Default impl that calls parent.propertyName = child If parent.propertyName is a Collection it will try to add child to the collection. \| \| `static class` \| `[ObjectGraphBuilder.DefaultClassNameResolver](objectgraphbuilder.defaultclassnameresolver)` \| Default impl that capitalizes the classname. \| \| `static class` \| `[ObjectGraphBuilder.DefaultIdentifierResolver](objectgraphbuilder.defaultidentifierresolver)` \| Default impl, always returns 'id' \| \| `static class` \| `[ObjectGraphBuilder.DefaultNewInstanceResolver](objectgraphbuilder.defaultnewinstanceresolver)` \| Default impl that calls Class.newInstance() \| \| `static class` \| `[ObjectGraphBuilder.DefaultReferenceResolver](objectgraphbuilder.defaultreferenceresolver)` \| Default impl, always returns 'refId' \| \| `static class` \| `[ObjectGraphBuilder.DefaultRelationNameResolver](objectgraphbuilder.defaultrelationnameresolver)` \| Default impl that returns parentName and childName accordingly. \| \| `interface` \| `[ObjectGraphBuilder.IdentifierResolver](objectgraphbuilder.identifierresolver)` \| Strategy for picking the correct synthetic identifier. \| \| `interface` \| `[ObjectGraphBuilder.NewInstanceResolver](objectgraphbuilder.newinstanceresolver)` \| Strategy for creating new instances of a class. \| \| `interface` \| `[ObjectGraphBuilder.ReferenceResolver](objectgraphbuilder.referenceresolver)` \| Strategy for picking the correct synthetic reference identifier. \| \| `class` \| `[ObjectGraphBuilder.ReflectionClassNameResolver](objectgraphbuilder.reflectionclassnameresolver)` \| Build objects using reflection to resolve class names. \| \| `interface` \| `[ObjectGraphBuilder.RelationNameResolver](objectgraphbuilder.relationnameresolver)` \| Strategy for resolving a relationship property name. \| Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[CLASSNAME\_RESOLVER\_KEY](#CLASSNAME_RESOLVER_KEY)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[CLASSNAME\_RESOLVER\_REFLECTION](#CLASSNAME_RESOLVER_REFLECTION)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[CLASSNAME\_RESOLVER\_REFLECTION\_ROOT](#CLASSNAME_RESOLVER_REFLECTION_ROOT)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[LAZY\_REF](#LAZY_REF)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[NODE\_CLASS](#NODE_CLASS)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[NODE\_NAME](#NODE_NAME)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[OBJECT\_ID](#OBJECT_ID)` \| \| Inherited fields \| Fields inherited from class \| Fields \| \| `class [FactoryBuilderSupport](factorybuildersupport "FactoryBuilderSupport")` \| `CURRENT_FACTORY, PARENT_FACTORY, PARENT_NODE, CURRENT_NODE, PARENT_CONTEXT, PARENT_NAME, CURRENT_NAME, OWNER, PARENT_BUILDER, CURRENT_BUILDER, CHILD_BUILDER, SCRIPT_CLASS_NAME` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[ObjectGraphBuilder](#ObjectGraphBuilder())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public void` \| `[doCall](#doCall(groovy.util.ObjectGraphBuilder,%20java.lang.Object,%20java.lang.Object))([ObjectGraphBuilder](objectgraphbuilder) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node)` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getBeanFactoryName](#getBeanFactoryName())()`Returns the current name of the 'bean' node. \| \| \| `public [ObjectGraphBuilder.ChildPropertySetter](objectgraphbuilder.childpropertysetter)` \| `[getChildPropertySetter](#getChildPropertySetter())()`Returns the current ChildPropertySetter. \| \| \| `public [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html "ClassLoader")` \| `[getClassLoader](#getClassLoader())()`Returns the classLoader used to load a node's class. \| \| \| `public [ClassNameResolver](../../classnameresolver)` \| `[getClassNameResolver](#getClassNameResolver())()`Returns the current ClassNameResolver. \| \| \| `public [NewInstanceResolver](../../newinstanceresolver)` \| `[getNewInstanceResolver](#getNewInstanceResolver())()`Returns the current NewInstanceResolver. \| \| \| `public [ObjectGraphBuilder.RelationNameResolver](objectgraphbuilder.relationnameresolver)` \| `[getRelationNameResolver](#getRelationNameResolver())()`Returns the current RelationNameResolver. \| \| \| `public boolean` \| `[isLazyReferencesAllowed](#isLazyReferencesAllowed())()`Returns true if references can be resolved lazily \| \| \| `protected void` \| `[postInstantiate](#postInstantiate(java.lang.Object,%20java.util.Map,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node)` \| \| \| `protected void` \| `[preInstantiate](#preInstantiate(java.lang.Object,%20java.util.Map,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| \| \| `protected [Factory](factory)` \| `[resolveFactory](#resolveFactory(java.lang.Object,%20java.util.Map,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| \| \| `public void` \| `[setBeanFactoryName](#setBeanFactoryName(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") beanFactoryName)`Sets the name for the 'bean' node. \| \| \| `public void` \| `[setChildPropertySetter](#setChildPropertySetter(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") childPropertySetter)`Sets the current ChildPropertySetter. \| \| \| `public void` \| `[setClassLoader](#setClassLoader(java.lang.ClassLoader))([ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html "ClassLoader") classLoader)`Sets the classLoader used to load a node's class. \| \| \| `public void` \| `[setClassNameResolver](#setClassNameResolver(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") classNameResolver)`Sets the current ClassNameResolver. \| \| \| `public void` \| `[setIdentifierResolver](#setIdentifierResolver(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") identifierResolver)`Sets the current IdentifierResolver. \| \| \| `public void` \| `[setLazyReferencesAllowed](#setLazyReferencesAllowed(boolean))(boolean lazyReferencesAllowed)`Sets whether references can be resolved lazily or not. \| \| \| `public void` \| `[setNewInstanceResolver](#setNewInstanceResolver(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstanceResolver)`Sets the current NewInstanceResolver. \| \| \| `public void` \| `[setReferenceResolver](#setReferenceResolver(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") referenceResolver)`Sets the current ReferenceResolver. \| \| \| `public void` \| `[setRelationNameResolver](#setRelationNameResolver(groovy.util.ObjectGraphBuilder.RelationNameResolver))([ObjectGraphBuilder.RelationNameResolver](objectgraphbuilder.relationnameresolver) relationNameResolver)`Sets the current RelationNameResolver. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [FactoryBuilderSupport](factorybuildersupport "FactoryBuilderSupport")` \| `[getName](factorybuildersupport#getName(java.lang.String) "getName"), [getProperty](factorybuildersupport#getProperty(java.lang.String) "getProperty"), [setProperty](factorybuildersupport#setProperty(java.lang.String,%20java.lang.Object) "setProperty"), [getContext](factorybuildersupport#getContext() "getContext"), [build](factorybuildersupport#build(java.lang.String,%20groovy.lang.GroovyClassLoader) "build"), [build](factorybuildersupport#build(java.lang.Class) "build"), [build](factorybuildersupport#build(groovy.lang.Script) "build"), [dispose](factorybuildersupport#dispose() "dispose"), [invokeMethod](factorybuildersupport#invokeMethod(java.lang.String,%20java.lang.Object) "invokeMethod"), [invokeMethod](factorybuildersupport#invokeMethod(java.lang.String) "invokeMethod"), [getCurrent](factorybuildersupport#getCurrent() "getCurrent"), [registerFactory](factorybuildersupport#registerFactory(java.lang.String,%20groovy.util.Factory) "registerFactory"), [registerFactory](factorybuildersupport#registerFactory(java.lang.String,%20java.lang.String,%20groovy.util.Factory) "registerFactory"), [getVariable](factorybuildersupport#getVariable(java.lang.String) "getVariable"), [setVariable](factorybuildersupport#setVariable(java.lang.String,%20java.lang.Object) "setVariable"), [getVariables](factorybuildersupport#getVariables() "getVariables"), [getParentNode](factorybuildersupport#getParentNode() "getParentNode"), [getCurrentName](factorybuildersupport#getCurrentName() "getCurrentName"), [autoRegisterNodes](factorybuildersupport#autoRegisterNodes() "autoRegisterNodes"), [getParentName](factorybuildersupport#getParentName() "getParentName"), [getContextAttribute](factorybuildersupport#getContextAttribute(java.lang.String) "getContextAttribute"), [registerBeanFactory](factorybuildersupport#registerBeanFactory(java.lang.String,%20java.lang.String,%20java.lang.Class) "registerBeanFactory"), [registerBeanFactory](factorybuildersupport#registerBeanFactory(java.lang.String,%20java.lang.Class) "registerBeanFactory"), [getPostInstantiateDelegates](factorybuildersupport#getPostInstantiateDelegates() "getPostInstantiateDelegates"), [getLocalExplicitMethods](factorybuildersupport#getLocalExplicitMethods() "getLocalExplicitMethods"), [getPostNodeCompletionDelegates](factorybuildersupport#getPostNodeCompletionDelegates() "getPostNodeCompletionDelegates"), [getRegistrationGroupItems](factorybuildersupport#getRegistrationGroupItems(java.lang.String) "getRegistrationGroupItems"), [getMethodMissingDelegate](factorybuildersupport#getMethodMissingDelegate() "getMethodMissingDelegate"), [getPropertyMissingDelegate](factorybuildersupport#getPropertyMissingDelegate() "getPropertyMissingDelegate"), [setPropertyMissingDelegate](factorybuildersupport#setPropertyMissingDelegate(groovy.lang.Closure) "setPropertyMissingDelegate"), [addAttributeDelegate](factorybuildersupport#addAttributeDelegate(groovy.lang.Closure) "addAttributeDelegate"), [addPostInstantiateDelegate](factorybuildersupport#addPostInstantiateDelegate(groovy.lang.Closure) "addPostInstantiateDelegate"), [getRegistrationGroups](factorybuildersupport#getRegistrationGroups() "getRegistrationGroups"), [registerExplicitProperty](factorybuildersupport#registerExplicitProperty(java.lang.String,%20groovy.lang.Closure,%20groovy.lang.Closure) "registerExplicitProperty"), [registerExplicitProperty](factorybuildersupport#registerExplicitProperty(java.lang.String,%20java.lang.String,%20groovy.lang.Closure,%20groovy.lang.Closure) "registerExplicitProperty"), [getExplicitProperties](factorybuildersupport#getExplicitProperties() "getExplicitProperties"), [getLocalExplicitProperties](factorybuildersupport#getLocalExplicitProperties() "getLocalExplicitProperties"), [setMethodMissingDelegate](factorybuildersupport#setMethodMissingDelegate(groovy.lang.Closure) "setMethodMissingDelegate"), [registerExplicitMethod](factorybuildersupport#registerExplicitMethod(java.lang.String,%20groovy.lang.Closure) "registerExplicitMethod"), [registerExplicitMethod](factorybuildersupport#registerExplicitMethod(java.lang.String,%20java.lang.String,%20groovy.lang.Closure) "registerExplicitMethod"), [addPostNodeCompletionDelegate](factorybuildersupport#addPostNodeCompletionDelegate(groovy.lang.Closure) "addPostNodeCompletionDelegate"), [removePostInstantiateDelegate](factorybuildersupport#removePostInstantiateDelegate(groovy.lang.Closure) "removePostInstantiateDelegate"), [removeAttributeDelegate](factorybuildersupport#removeAttributeDelegate(groovy.lang.Closure) "removeAttributeDelegate"), [getNameMappingClosure](factorybuildersupport#getNameMappingClosure() "getNameMappingClosure"), [getPreInstantiateDelegates](factorybuildersupport#getPreInstantiateDelegates() "getPreInstantiateDelegates"), [addPreInstantiateDelegate](factorybuildersupport#addPreInstantiateDelegate(groovy.lang.Closure) "addPreInstantiateDelegate"), [getAttributeDelegates](factorybuildersupport#getAttributeDelegates() "getAttributeDelegates"), [removePreInstantiateDelegate](factorybuildersupport#removePreInstantiateDelegate(groovy.lang.Closure) "removePreInstantiateDelegate"), [removePostNodeCompletionDelegate](factorybuildersupport#removePostNodeCompletionDelegate(groovy.lang.Closure) "removePostNodeCompletionDelegate"), [setNameMappingClosure](factorybuildersupport#setNameMappingClosure(groovy.lang.Closure) "setNameMappingClosure"), [checkValueIsTypeNotString](factorybuildersupport#checkValueIsTypeNotString(java.lang.Object,%20java.lang.Object,%20java.lang.Class) "checkValueIsTypeNotString"), [getDisposalClosures](factorybuildersupport#getDisposalClosures() "getDisposalClosures"), [getChildBuilder](factorybuildersupport#getChildBuilder() "getChildBuilder"), [getFactories](factorybuildersupport#getFactories() "getFactories"), [getExplicitMethods](factorybuildersupport#getExplicitMethods() "getExplicitMethods"), [getParentFactory](factorybuildersupport#getParentFactory() "getParentFactory"), [getCurrentBuilder](factorybuildersupport#getCurrentBuilder() "getCurrentBuilder"), [withBuilder](factorybuildersupport#withBuilder(groovy.util.FactoryBuilderSupport,%20groovy.lang.Closure) "withBuilder"), [withBuilder](factorybuildersupport#withBuilder(groovy.util.FactoryBuilderSupport,%20java.lang.String,%20groovy.lang.Closure) "withBuilder"), [withBuilder](factorybuildersupport#withBuilder(java.util.Map,%20groovy.util.FactoryBuilderSupport,%20java.lang.String,%20groovy.lang.Closure) "withBuilder"), [getCurrentFactory](factorybuildersupport#getCurrentFactory() "getCurrentFactory"), [checkValueIsNull](factorybuildersupport#checkValueIsNull(java.lang.Object,%20java.lang.Object) "checkValueIsNull"), [checkValueIsType](factorybuildersupport#checkValueIsType(java.lang.Object,%20java.lang.Object,%20java.lang.Class) "checkValueIsType"), [getParentContext](factorybuildersupport#getParentContext() "getParentContext"), [getLocalFactories](factorybuildersupport#getLocalFactories() "getLocalFactories"), [addDisposalClosure](factorybuildersupport#addDisposalClosure(groovy.lang.Closure) "addDisposalClosure"), [hasVariable](factorybuildersupport#hasVariable(java.lang.String) "hasVariable"), [removeVariable](factorybuildersupport#removeVariable(java.lang.String) "removeVariable"), [setMetaClass](factorybuildersupport#setMetaClass(groovy.lang.MetaClass) "setMetaClass"), [getMetaClass](factorybuildersupport#getMetaClass() "getMetaClass"), [wait](factorybuildersupport#wait(long,%20int) "wait"), [wait](factorybuildersupport#wait() "wait"), [wait](factorybuildersupport#wait(long) "wait"), [equals](factorybuildersupport#equals(java.lang.Object) "equals"), [toString](factorybuildersupport#toString() "toString"), [hashCode](factorybuildersupport#hashCode() "hashCode"), [getClass](factorybuildersupport#getClass() "getClass"), [notify](factorybuildersupport#notify() "notify"), [notifyAll](factorybuildersupport#notifyAll() "notifyAll")` \| Field Detail ------------ ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") CLASSNAME\_RESOLVER\_KEY ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") CLASSNAME\_RESOLVER\_REFLECTION ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") CLASSNAME\_RESOLVER\_REFLECTION\_ROOT ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") LAZY\_REF ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") NODE\_CLASS ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") NODE\_NAME ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") OBJECT\_ID Constructor Detail ------------------ ### public ObjectGraphBuilder() Method Detail ------------- ### public void doCall([ObjectGraphBuilder](objectgraphbuilder) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node) ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getBeanFactoryName() Returns the current name of the 'bean' node. ### public [ObjectGraphBuilder.ChildPropertySetter](objectgraphbuilder.childpropertysetter) getChildPropertySetter() Returns the current ChildPropertySetter. ### public [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html "ClassLoader") getClassLoader() Returns the classLoader used to load a node's class. ### public [ClassNameResolver](../../classnameresolver) getClassNameResolver() Returns the current ClassNameResolver. ### public [NewInstanceResolver](../../newinstanceresolver) getNewInstanceResolver() Returns the current NewInstanceResolver. ### public [ObjectGraphBuilder.RelationNameResolver](objectgraphbuilder.relationnameresolver) getRelationNameResolver() Returns the current RelationNameResolver. ### public boolean isLazyReferencesAllowed() Returns true if references can be resolved lazily ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected void postInstantiate([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected void preInstantiate([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected [Factory](factory) resolveFactory([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) ### public void setBeanFactoryName([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") beanFactoryName) Sets the name for the 'bean' node. ### public void setChildPropertySetter([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") childPropertySetter) Sets the current ChildPropertySetter. It will assign DefaultChildPropertySetter if null. It accepts a ChildPropertySetter instance or a Closure. ### public void setClassLoader([ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html "ClassLoader") classLoader) Sets the classLoader used to load a node's class. ### public void setClassNameResolver([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") classNameResolver) Sets the current ClassNameResolver. It will assign DefaultClassNameResolver if null. It accepts a ClassNameResolver instance, a String, a Closure or a Map. ### public void setIdentifierResolver([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") identifierResolver) Sets the current IdentifierResolver. It will assign DefaultIdentifierResolver if null. It accepts a IdentifierResolver instance, a String or a Closure. ### public void setLazyReferencesAllowed(boolean lazyReferencesAllowed) Sets whether references can be resolved lazily or not. ### public void setNewInstanceResolver([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstanceResolver) Sets the current NewInstanceResolver. It will assign DefaultNewInstanceResolver if null. It accepts a NewInstanceResolver instance or a Closure. ### public void setReferenceResolver([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") referenceResolver) Sets the current ReferenceResolver. It will assign DefaultReferenceResolver if null. It accepts a ReferenceResolver instance, a String or a Closure. ### public void setRelationNameResolver([ObjectGraphBuilder.RelationNameResolver](objectgraphbuilder.relationnameresolver) relationNameResolver) Sets the current RelationNameResolver. It will assign DefaultRelationNameResolver if null.	programming_docs
groovy [Java] Class ObjectGraphBuilder.DefaultClassNameResolver [Java] Class ObjectGraphBuilder.DefaultClassNameResolver ======================================================== * groovy.util.ObjectGraphBuilder.DefaultClassNameResolver All Implemented Interfaces and Traits: [ClassNameResolver](../../classnameresolver) ``` public static class ObjectGraphBuilder.DefaultClassNameResolver ``` Default impl that capitalizes the classname. Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[resolveClassname](#resolveClassname(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") classname)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") resolveClassname([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") classname) groovy [Java] Interface ObjectGraphBuilder.ChildPropertySetter [Java] Interface ObjectGraphBuilder.ChildPropertySetter ======================================================= ``` public interface ObjectGraphBuilder.ChildPropertySetter ``` Strategy for setting a child node on its parent. Useful for handling Lists/Arrays vs normal properties. Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public void` \| `[setChild](#setChild(java.lang.Object,%20java.lang.Object,%20java.lang.String,%20java.lang.String))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") parentName, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") propertyName)` Parameters: `parent` - the parent's node value \| Method Detail ------------- ### public void setChild([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") parentName, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") propertyName) Parameters: `parent` - the parent's node value `child` - the child's node value `parentName` - the name of the parent node `propertyName` - the resolved relation name of the child groovy [Java] Class ObjectGraphBuilder.DefaultIdentifierResolver [Java] Class ObjectGraphBuilder.DefaultIdentifierResolver ========================================================= * groovy.util.ObjectGraphBuilder.DefaultIdentifierResolver All Implemented Interfaces and Traits: [ObjectGraphBuilder.IdentifierResolver](objectgraphbuilder.identifierresolver) ``` public static class ObjectGraphBuilder.DefaultIdentifierResolver ``` Default impl, always returns 'id' Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getIdentifierFor](#getIdentifierFor(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") nodeName)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getIdentifierFor([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") nodeName) groovy [Java] Class GroovyScriptEngine [Java] Class GroovyScriptEngine =============================== * groovy.util.GroovyScriptEngine All Implemented Interfaces and Traits: [ResourceConnector](resourceconnector) ``` public class GroovyScriptEngine extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") implements [ResourceConnector](resourceconnector) ``` Specific script engine able to reload modified scripts as well as dealing properly with dependent scripts. Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[GroovyScriptEngine](#GroovyScriptEngine(java.net.URL))([URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html "URL")[] roots)` \| \| `[GroovyScriptEngine](#GroovyScriptEngine(java.net.URL,%20java.lang.ClassLoader))([URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html "URL")[] roots, [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html "ClassLoader") parentClassLoader)` \| \| `[GroovyScriptEngine](#GroovyScriptEngine(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")[] urls)` \| \| `[GroovyScriptEngine](#GroovyScriptEngine(java.lang.String,%20java.lang.ClassLoader))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")[] urls, [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html "ClassLoader") parentClassLoader)` \| \| `[GroovyScriptEngine](#GroovyScriptEngine(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") url)` \| \| `[GroovyScriptEngine](#GroovyScriptEngine(java.lang.String,%20java.lang.ClassLoader))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") url, [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html "ClassLoader") parentClassLoader)` \| \| `[GroovyScriptEngine](#GroovyScriptEngine(groovy.util.ResourceConnector))([ResourceConnector](resourceconnector) rc)` \| \| `[GroovyScriptEngine](#GroovyScriptEngine(groovy.util.ResourceConnector,%20java.lang.ClassLoader))([ResourceConnector](resourceconnector) rc, [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html "ClassLoader") parentClassLoader)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [Script](../lang/script)` \| `[createScript](#createScript(java.lang.String,%20groovy.lang.Binding))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") scriptName, [Binding](../lang/binding) binding)`Creates a Script with a given scriptName and binding. \| \| \| `public [CompilerConfiguration](../../org/codehaus/groovy/control/compilerconfiguration)` \| `[getConfig](#getConfig())()` Returns: a non null compiler configuration \| \| \| `protected long` \| `[getCurrentTime](#getCurrentTime())()` \| \| \| `public [GroovyClassLoader](../lang/groovyclassloader)` \| `[getGroovyClassLoader](#getGroovyClassLoader())()`Returns the GroovyClassLoader associated with this script engine instance. \| \| \| `public [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html "ClassLoader")` \| `[getParentClassLoader](#getParentClassLoader())()`Get the `ClassLoader` that will serve as the parent ClassLoader of the [GroovyClassLoader](../lang/groovyclassloader "GroovyClassLoader") in which scripts will be executed. \| \| \| `public [URLConnection](https://docs.oracle.com/javase/8/docs/api/java/net/URLConnection.html "URLConnection")` \| `[getResourceConnection](#getResourceConnection(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") resourceName)`Get a resource connection as a `URLConnection` to retrieve a script from the `ResourceConnector`. \| \| \| `protected boolean` \| `[isSourceNewer](#isSourceNewer(ScriptCacheEntry))([ScriptCacheEntry](../../scriptcacheentry) entry)` \| \| \| `public [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")` \| `[loadScriptByName](#loadScriptByName(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") scriptName)`Get the class of the scriptName in question, so that you can instantiate Groovy objects with caching and reloading. \| \| \| `public static void` \| `[main](#main(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")[] urls)`Simple testing harness for the GSE. \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[run](#run(java.lang.String,%20java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") scriptName, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") argument)`Run a script identified by name with a single argument. \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[run](#run(java.lang.String,%20groovy.lang.Binding))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") scriptName, [Binding](../lang/binding) binding)`Run a script identified by name with a given binding. \| \| \| `public void` \| `[setConfig](#setConfig(org.codehaus.groovy.control.CompilerConfiguration))([CompilerConfiguration](../../org/codehaus/groovy/control/compilerconfiguration) config)`sets a compiler configuration \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public GroovyScriptEngine([URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html "URL")[] roots) ### public GroovyScriptEngine([URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html "URL")[] roots, [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html "ClassLoader") parentClassLoader) ### public GroovyScriptEngine([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")[] urls) ### public GroovyScriptEngine([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")[] urls, [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html "ClassLoader") parentClassLoader) ### public GroovyScriptEngine([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") url) ### public GroovyScriptEngine([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") url, [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html "ClassLoader") parentClassLoader) ### public GroovyScriptEngine([ResourceConnector](resourceconnector) rc) ### public GroovyScriptEngine([ResourceConnector](resourceconnector) rc, [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html "ClassLoader") parentClassLoader) Method Detail ------------- ### public [Script](../lang/script) createScript([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") scriptName, [Binding](../lang/binding) binding) Creates a Script with a given scriptName and binding. throws: ResourceException if there is a problem accessing the script throws: ScriptException if there is a problem parsing the script Parameters: `scriptName` - name of the script to run `binding` - the binding to pass to the script Returns: the script object ### public [CompilerConfiguration](../../org/codehaus/groovy/control/compilerconfiguration) getConfig() Returns: a non null compiler configuration ### protected long getCurrentTime() ### public [GroovyClassLoader](../lang/groovyclassloader) getGroovyClassLoader() Returns the GroovyClassLoader associated with this script engine instance. Useful if you need to pass the class loader to another library. Returns: the GroovyClassLoader ### public [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html "ClassLoader") getParentClassLoader() Get the `ClassLoader` that will serve as the parent ClassLoader of the [GroovyClassLoader](../lang/groovyclassloader "GroovyClassLoader") in which scripts will be executed. By default, this is the ClassLoader that loaded the `GroovyScriptEngine` class. Returns: the parent classloader used to load scripts ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [URLConnection](https://docs.oracle.com/javase/8/docs/api/java/net/URLConnection.html "URLConnection") getResourceConnection([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") resourceName) Get a resource connection as a `URLConnection` to retrieve a script from the `ResourceConnector`. throws: ResourceException Parameters: `resourceName` - name of the resource to be retrieved Returns: a URLConnection to the resource ### protected boolean isSourceNewer([ScriptCacheEntry](../../scriptcacheentry) entry) ### public [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") loadScriptByName([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") scriptName) Get the class of the scriptName in question, so that you can instantiate Groovy objects with caching and reloading. throws: ResourceException if there is a problem accessing the script throws: ScriptException if there is a problem parsing the script Parameters: `scriptName` - resource name pointing to the script Returns: the loaded scriptName as a compiled class ### public static void main([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")[] urls) Simple testing harness for the GSE. Enter script roots as arguments and then input script names to run them. throws: Exception if something goes wrong Parameters: `urls` - an array of URLs ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") run([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") scriptName, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") argument) Run a script identified by name with a single argument. throws: ResourceException if there is a problem accessing the script throws: ScriptException if there is a problem parsing the script Parameters: `scriptName` - name of the script to run `argument` - a single argument passed as a variable named `arg` in the binding Returns: a `toString()` representation of the result of the execution of the script ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") run([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") scriptName, [Binding](../lang/binding) binding) Run a script identified by name with a given binding. throws: ResourceException if there is a problem accessing the script throws: ScriptException if there is a problem parsing the script Parameters: `scriptName` - name of the script to run `binding` - the binding to pass to the script Returns: an object ### public void setConfig([CompilerConfiguration](../../org/codehaus/groovy/control/compilerconfiguration) config) sets a compiler configuration throws: NullPointerException if config is null Parameters: `config` - - the compiler configuration groovy [Java] Class ObjectGraphBuilder.DefaultRelationNameResolver [Java] Class ObjectGraphBuilder.DefaultRelationNameResolver =========================================================== * groovy.util.ObjectGraphBuilder.DefaultRelationNameResolver All Implemented Interfaces and Traits: [ObjectGraphBuilder.RelationNameResolver](objectgraphbuilder.relationnameresolver) ``` public static class ObjectGraphBuilder.DefaultRelationNameResolver ``` Default impl that returns parentName and childName accordingly. Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[resolveChildRelationName](#resolveChildRelationName(java.lang.String,%20java.lang.Object,%20java.lang.String,%20java.lang.Object))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") parentName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") childName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child)`Handles the common English regular plurals with the following rules. \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[resolveParentRelationName](#resolveParentRelationName(java.lang.String,%20java.lang.Object,%20java.lang.String,%20java.lang.Object))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") parentName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") childName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child)`Follow the most conventional pattern, returns the parentName unchanged. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") resolveChildRelationName([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") parentName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") childName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child) Handles the common English regular plurals with the following rules. * If childName ends in {consonant}y, replace 'y' with "ies". For example, allergy to allergies. * Otherwise, append 's'. For example, monkey to monkeys; employee to employees. If the property does not exist then it will return childName unchanged. See Also: [English\_plural](http://en.wikipedia.org/wiki/English_plural) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") resolveParentRelationName([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") parentName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") childName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child) Follow the most conventional pattern, returns the parentName unchanged.	programming_docs
groovy [Java] Class DelegatingScript [Java] Class DelegatingScript ============================= * groovy.util.DelegatingScript ``` public abstract class DelegatingScript extends [Script](../lang/script) ``` [Script](../lang/script "Script") that performs method invocations and property access like [Closure](../lang/closure "Closure") does. [DelegatingScript](delegatingscript "DelegatingScript") is a convenient basis for loading a custom-defined DSL as a [Script](../lang/script "Script"), then execute it. The following sample code illustrates how to do it: ``` class MyDSL { public void foo(int x, int y, Closure z) { ... } public void setBar(String a) { ... } } CompilerConfiguration cc = new CompilerConfiguration(); cc.setScriptBaseClass(DelegatingScript.class.getName()); GroovyShell sh = new GroovyShell(cl,new Binding(),cc); DelegatingScript script = (DelegatingScript)sh.parse(new File("my.dsl")) script.setDelegate(new MyDSL()); script.run(); ``` my.dsl can look like this: ``` foo(1,2) { .... } bar = ...; ``` [DelegatingScript](delegatingscript "DelegatingScript") does this by delegating property access and method invocation to the delegate object. More formally speaking, given the following script: ``` a = 1; b(2); ``` Using [DelegatingScript](delegatingscript "DelegatingScript") as the base class, the code will run as: ``` delegate.a = 1; delegate.b(2); ``` ... whereas in plain [Script](../lang/script "Script"), this will be run as: ``` binding.setProperty("a",1); ((Closure)binding.getProperty("b")).call(2); ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `protected [DelegatingScript](#DelegatingScript())()` \| \| `protected [DelegatingScript](#DelegatingScript(groovy.lang.Binding))([Binding](../lang/binding) binding)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getDelegate](#getDelegate())()` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getProperty](#getProperty(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") property)` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[invokeMethod](#invokeMethod(java.lang.String,%20java.lang.Object))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args)` \| \| \| `public void` \| `[setDelegate](#setDelegate(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") delegate)`Sets the delegation target. \| \| \| `public void` \| `[setProperty](#setProperty(java.lang.String,%20java.lang.Object))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") property, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newValue)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Script](../lang/script)` \| `[evaluate](../lang/script#evaluate(java.lang.String)), [evaluate](../lang/script#evaluate(java.io.File)), [getBinding](../lang/script#getBinding()), [getProperty](../lang/script#getProperty(java.lang.String)), [invokeMethod](../lang/script#invokeMethod(java.lang.String,%20java.lang.Object)), [print](../lang/script#print(java.lang.Object)), [printf](../lang/script#printf(java.lang.String,%20java.lang.Object)), [printf](../lang/script#printf(java.lang.String,%20java.lang.Object)), [println](../lang/script#println()), [println](../lang/script#println(java.lang.Object)), [run](../lang/script#run()), [run](../lang/script#run(java.io.File,%20java.lang.String)), [setBinding](../lang/script#setBinding(groovy.lang.Binding)), [setProperty](../lang/script#setProperty(java.lang.String,%20java.lang.Object))` \| \| `class [GroovyObjectSupport](../lang/groovyobjectsupport)` \| `[getMetaClass](../lang/groovyobjectsupport#getMetaClass()), [setMetaClass](../lang/groovyobjectsupport#setMetaClass(groovy.lang.MetaClass))` \| Constructor Detail ------------------ ### protected DelegatingScript() ### protected DelegatingScript([Binding](../lang/binding) binding) Method Detail ------------- ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getDelegate() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getProperty([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") property) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") invokeMethod([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args) ### public void setDelegate([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") delegate) Sets the delegation target. ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void setProperty([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") property, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newValue) groovy [Java] Class ObservableSet.ElementEvent [Java] Class ObservableSet.ElementEvent ======================================= * groovy.util.ObservableSet.ElementEvent ``` public static abstract class ObservableSet.ElementEvent extends [PropertyChangeEvent](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html "PropertyChangeEvent") ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[ElementEvent](#ElementEvent(java.lang.Object,%20java.lang.Object,%20java.lang.Object,%20ChangeType))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") source, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") oldValue, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newValue, [ChangeType](../../changetype) type)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [ChangeType](../../changetype)` \| `[getChangeType](#getChangeType())()` \| \| \| `public int` \| `[getType](#getType())()` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getTypeAsString](#getTypeAsString())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [PropertyChangeEvent](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html "PropertyChangeEvent")` \| `[toString](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html#toString() "toString"), [getPropertyName](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html#getPropertyName() "getPropertyName"), [getOldValue](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html#getOldValue() "getOldValue"), [getPropagationId](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html#getPropagationId() "getPropagationId"), [setPropagationId](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html#setPropagationId(java.lang.Object) "setPropagationId"), [getNewValue](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html#getNewValue() "getNewValue"), [getSource](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html#getSource() "getSource"), [wait](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html#equals(java.lang.Object) "equals"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeEvent.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public ElementEvent([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") source, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") oldValue, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newValue, [ChangeType](../../changetype) type) Method Detail ------------- ### public [ChangeType](../../changetype) getChangeType() ### public int getType() ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getTypeAsString() groovy [Java] Annotation Type Slf4j [Java] Annotation Type Slf4j ============================ * groovy.util.logging.Slf4j ``` @[Documented](https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Documented.html "Documented") @[Retention](https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html "Retention")(RetentionPolicy.SOURCE) @[Target](https://docs.groovy-lang.org/docs/ant/api/org/apache/tools/ant/Target.html "Target")({ElementType.TYPE}) @[GroovyASTTransformationClass](../../../org/codehaus/groovy/transform/groovyasttransformationclass "GroovyASTTransformationClass")("org.codehaus.groovy.transform.LogASTTransformation") public @interface Slf4j ``` This local transform adds a logging ability to your program using LogBack logging. Every method call on a unbound variable named log will be mapped to a call to the logger. For this a log field will be inserted in the class. If the field already exists the usage of this transform will cause a compilation error. The method name will be used to determine what to call on the logger. ``` log.name(exp) ``` is mapped to ``` if (log.isNameLoggable() { log.name(exp) } ``` Here name is a place holder for info, debug, warning, error, etc. If the expression exp is a constant or only a variable access the method call will not be transformed. But this will still cause a call on the injected logger. Since: 1.8.0 Element Summary --------------- Optional Element Summary \| Type \| Name and Description \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[category](#category)` Default: LogASTTransformation.DEFAULT\_CATEGORY\_NAME \| \| `[Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<? extends LogASTTransformation.LoggingStrategy>` \| `[loggingStrategy](#loggingStrategy)` Default: Slf4jLoggingStrategy.class \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[value](#value)` Default: "log" \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[visibilityId](#visibilityId)`If specified, must match the "id" attribute in a VisibilityOptions annotation to enable a custom visibility. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Element Detail -------------- ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") category Default: LogASTTransformation.DEFAULT\_CATEGORY\_NAME ### public [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<? extends LogASTTransformation.LoggingStrategy> loggingStrategy Default: Slf4jLoggingStrategy.class ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") value Default: "log" ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") visibilityId If specified, must match the "id" attribute in a VisibilityOptions annotation to enable a custom visibility. Since: 3.0.0 Default: Undefined.STRING groovy [Java] Annotation Type PlatformLog [Java] Annotation Type PlatformLog ================================== * groovy.util.logging.PlatformLog ``` @[Documented](https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Documented.html "Documented") @[Retention](https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html "Retention")(RetentionPolicy.SOURCE) @[Target](https://docs.groovy-lang.org/docs/ant/api/org/apache/tools/ant/Target.html "Target")({ElementType.TYPE}) @[GroovyASTTransformationClass](../../../org/codehaus/groovy/transform/groovyasttransformationclass "GroovyASTTransformationClass")("org.codehaus.groovy.transform.LogASTTransformation") public @interface PlatformLog ``` This local transform adds a logging ability to your program using java.logging. Every method call on a unbound variable named log will be mapped to a call to the logger. For this a log field will be inserted in the class. If the field already exists the usage of this transform will cause a compilation error. The method name will be used to determine what to call on the logger. ``` import groovy.util.logging.* import static java.lang.System.Logger.Level.INFO @PlatformLog class Foo { def method() { log.log INFO, 'Foobar' } } new Foo().method() ``` Since: 4.0.0 Element Summary --------------- Optional Element Summary \| Type \| Name and Description \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[category](#category)` Default: LogASTTransformation.DEFAULT\_CATEGORY\_NAME \| \| `[Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<? extends LoggingStrategy>` \| `[loggingStrategy](#loggingStrategy)` Default: JavaUtilLoggingStrategy.class \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[value](#value)` Default: "log" \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[visibilityId](#visibilityId)`If specified, must match the "id" attribute in a VisibilityOptions annotation to enable a custom visibility. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Element Detail -------------- ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") category Default: LogASTTransformation.DEFAULT\_CATEGORY\_NAME ### public [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<? extends LoggingStrategy> loggingStrategy Default: JavaUtilLoggingStrategy.class ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") value Default: "log" ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") visibilityId If specified, must match the "id" attribute in a VisibilityOptions annotation to enable a custom visibility. Default: Undefined.STRING groovy [Java] Annotation Type Commons [Java] Annotation Type Commons ============================== * groovy.util.logging.Commons ``` @[Documented](https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Documented.html "Documented") @[Retention](https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html "Retention")(RetentionPolicy.SOURCE) @[Target](https://docs.groovy-lang.org/docs/ant/api/org/apache/tools/ant/Target.html "Target")({ElementType.TYPE}) @[GroovyASTTransformationClass](../../../org/codehaus/groovy/transform/groovyasttransformationclass "GroovyASTTransformationClass")("org.codehaus.groovy.transform.LogASTTransformation") public @interface Commons ``` This local transform adds a logging ability to your program using Apache Commons logging. Every method call on a unbound variable named log will be mapped to a call to the logger. For this a log field will be inserted in the class. If the field already exists the usage of this transform will cause a compilation error. The method name will be used to determine what to call on the logger. ``` log.name(exp) ``` is mapped to ``` if (log.isNameEnabled() { log.name(exp) } ``` Here name is a place holder for info, debug, warning, error, etc. If the expression exp is a constant or only a variable access the method call will not be transformed. But this will still cause a call on the injected logger. Since: 1.8.0 Element Summary --------------- Optional Element Summary \| Type \| Name and Description \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[category](#category)` Default: LogASTTransformation.DEFAULT\_CATEGORY\_NAME \| \| `[Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<? extends LogASTTransformation.LoggingStrategy>` \| `[loggingStrategy](#loggingStrategy)` Default: CommonsLoggingStrategy.class \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[value](#value)` Default: "log" \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[visibilityId](#visibilityId)`If specified, must match the "id" attribute in a VisibilityOptions annotation to enable a custom visibility. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Element Detail -------------- ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") category Default: LogASTTransformation.DEFAULT\_CATEGORY\_NAME ### public [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<? extends LogASTTransformation.LoggingStrategy> loggingStrategy Default: CommonsLoggingStrategy.class ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") value Default: "log" ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") visibilityId If specified, must match the "id" attribute in a VisibilityOptions annotation to enable a custom visibility. Default: Undefined.STRING	programming_docs
groovy [Java] Annotation Type Log [Java] Annotation Type Log ========================== * groovy.util.logging.Log ``` @[Documented](https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Documented.html "Documented") @[Retention](https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html "Retention")(RetentionPolicy.SOURCE) @[Target](https://docs.groovy-lang.org/docs/ant/api/org/apache/tools/ant/Target.html "Target")({ElementType.TYPE}) @[GroovyASTTransformationClass](../../../org/codehaus/groovy/transform/groovyasttransformationclass "GroovyASTTransformationClass")("org.codehaus.groovy.transform.LogASTTransformation") public @interface Log ``` This local transform adds a logging ability to your program using java.util.logging. Every method call on a unbound variable named log will be mapped to a call to the logger. For this a log field will be inserted in the class. If the field already exists the usage of this transform will cause a compilation error. The method name will be used to determine what to call on the logger. ``` log.name(exp) ``` is mapped to ``` if (log.isLoggable(Level.NAME) { log.name(exp) } ``` Here name is a place holder for info, fine, finer, finest, config, warning, severe. NAME is name transformed to upper case. if anything else is used it will result in an exception at runtime. If the expression exp is a constant or only a variable access the method call will not be transformed. But this will still cause a call on the injected logger. Since: 1.8.0 Element Summary --------------- Optional Element Summary \| Type \| Name and Description \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[category](#category)` Default: LogASTTransformation.DEFAULT\_CATEGORY\_NAME \| \| `[Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<? extends LoggingStrategy>` \| `[loggingStrategy](#loggingStrategy)` Default: JavaUtilLoggingStrategy.class \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[value](#value)` Default: "log" \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[visibilityId](#visibilityId)`If specified, must match the "id" attribute in a VisibilityOptions annotation to enable a custom visibility. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Element Detail -------------- ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") category Default: LogASTTransformation.DEFAULT\_CATEGORY\_NAME ### public [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<? extends LoggingStrategy> loggingStrategy Default: JavaUtilLoggingStrategy.class ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") value Default: "log" ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") visibilityId If specified, must match the "id" attribute in a VisibilityOptions annotation to enable a custom visibility. Since: 3.0.0 Default: Undefined.STRING groovy [Java] Annotation Type Log4j2 [Java] Annotation Type Log4j2 ============================= * groovy.util.logging.Log4j2 ``` @[Documented](https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Documented.html "Documented") @[Retention](https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html "Retention")(RetentionPolicy.SOURCE) @[Target](https://docs.groovy-lang.org/docs/ant/api/org/apache/tools/ant/Target.html "Target")({ElementType.TYPE}) @[GroovyASTTransformationClass](../../../org/codehaus/groovy/transform/groovyasttransformationclass "GroovyASTTransformationClass")("org.codehaus.groovy.transform.LogASTTransformation") public @interface Log4j2 ``` This local transform adds a logging ability to your program using Log4j2 logging. Every method call on a unbound variable named log will be mapped to a call to the logger. For this a log field will be inserted in the class. If the field already exists the usage of this transform will cause a compilation error. The method name will be used to determine what to call on the logger. ``` log.name(exp) ``` is mapped to ``` if (log.isNameEnabled() { log.name(exp) } ``` Here name is a place holder for info, debug, warning, error, etc. If the expression exp is a constant or only a variable access the method call will not be transformed. But this will still cause a call on the injected logger. Since: 2.2.0 Element Summary --------------- Optional Element Summary \| Type \| Name and Description \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[category](#category)` Default: LogASTTransformation.DEFAULT\_CATEGORY\_NAME \| \| `[Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<? extends LogASTTransformation.LoggingStrategy>` \| `[loggingStrategy](#loggingStrategy)` Default: Log4j2LoggingStrategy.class \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[value](#value)` Default: "log" \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[visibilityId](#visibilityId)`If specified, must match the "id" attribute in a VisibilityOptions annotation to enable a custom visibility. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Element Detail -------------- ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") category Default: LogASTTransformation.DEFAULT\_CATEGORY\_NAME ### public [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<? extends LogASTTransformation.LoggingStrategy> loggingStrategy Default: Log4j2LoggingStrategy.class ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") value Default: "log" ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") visibilityId If specified, must match the "id" attribute in a VisibilityOptions annotation to enable a custom visibility. Since: 3.0.0 Default: Undefined.STRING groovy [Java] Annotation Type Log4j [Java] Annotation Type Log4j ============================ * groovy.util.logging.Log4j ``` @[Documented](https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Documented.html "Documented") @[Retention](https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html "Retention")(RetentionPolicy.SOURCE) @[Target](https://docs.groovy-lang.org/docs/ant/api/org/apache/tools/ant/Target.html "Target")({ElementType.TYPE}) @[GroovyASTTransformationClass](../../../org/codehaus/groovy/transform/groovyasttransformationclass "GroovyASTTransformationClass")("org.codehaus.groovy.transform.LogASTTransformation") public @interface Log4j ``` This local transform adds a logging ability to your program using Log4j logging. Every method call on a unbound variable named log will be mapped to a call to the logger. For this a log field will be inserted in the class. If the field already exists the usage of this transform will cause a compilation error. The method name will be used to determine what to call on the logger. ``` log.name(exp) ``` is mapped to ``` if (log.isNameEnabled() { log.name(exp) } ``` Here name is a place holder for info, debug, warning, error, etc. If the expression exp is a constant or only a variable access the method call will not be transformed. But this will still cause a call on the injected logger. Since: 1.8.0 Element Summary --------------- Optional Element Summary \| Type \| Name and Description \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[category](#category)` Default: LogASTTransformation.DEFAULT\_CATEGORY\_NAME \| \| `[Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<? extends LogASTTransformation.LoggingStrategy>` \| `[loggingStrategy](#loggingStrategy)` Default: Log4jLoggingStrategy.class \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[value](#value)` Default: "log" \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[visibilityId](#visibilityId)`If specified, must match the "id" attribute in a VisibilityOptions annotation to enable a custom visibility. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Element Detail -------------- ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") category Default: LogASTTransformation.DEFAULT\_CATEGORY\_NAME ### public [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<? extends LogASTTransformation.LoggingStrategy> loggingStrategy Default: Log4jLoggingStrategy.class ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") value Default: "log" ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") visibilityId If specified, must match the "id" attribute in a VisibilityOptions annotation to enable a custom visibility. Since: 3.0.0 Default: Undefined.STRING groovy [Java] Class GroovyCodeSourcePermission [Java] Class GroovyCodeSourcePermission ======================================= * groovy.security.GroovyCodeSourcePermission ``` public final class GroovyCodeSourcePermission extends [BasicPermission](https://docs.oracle.com/javase/8/docs/api/java/security/BasicPermission.html "BasicPermission") ``` Permission required to explicitly specify a codebase for a groovy script whose codebase cannot be determined. Typically this permission is only required by clients that want to associate a code source with a script which is a String or an InputStream. Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[GroovyCodeSourcePermission](#GroovyCodeSourcePermission(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name)` \| \| `[GroovyCodeSourcePermission](#GroovyCodeSourcePermission(java.lang.String,%20java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") actions)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [BasicPermission](https://docs.oracle.com/javase/8/docs/api/java/security/BasicPermission.html "BasicPermission")` \| `[equals](https://docs.oracle.com/javase/8/docs/api/java/security/BasicPermission.html#equals(java.lang.Object) "equals"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/security/BasicPermission.html#hashCode() "hashCode"), [implies](https://docs.oracle.com/javase/8/docs/api/java/security/BasicPermission.html#implies(java.security.Permission) "implies"), [getActions](https://docs.oracle.com/javase/8/docs/api/java/security/BasicPermission.html#getActions() "getActions"), [newPermissionCollection](https://docs.oracle.com/javase/8/docs/api/java/security/BasicPermission.html#newPermissionCollection() "newPermissionCollection"), [getName](https://docs.oracle.com/javase/8/docs/api/java/security/BasicPermission.html#getName() "getName"), [toString](https://docs.oracle.com/javase/8/docs/api/java/security/BasicPermission.html#toString() "toString"), [checkGuard](https://docs.oracle.com/javase/8/docs/api/java/security/BasicPermission.html#checkGuard(java.lang.Object) "checkGuard"), [wait](https://docs.oracle.com/javase/8/docs/api/java/security/BasicPermission.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/security/BasicPermission.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/security/BasicPermission.html#wait(long) "wait"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/security/BasicPermission.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/security/BasicPermission.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/security/BasicPermission.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public GroovyCodeSourcePermission([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name) ### public GroovyCodeSourcePermission([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") actions) groovy [Java] Class GroovyMBean [Java] Class GroovyMBean ======================== * groovy.jmx.GroovyMBean ``` public class GroovyMBean extends [GroovyObjectSupport](../lang/groovyobjectsupport) ``` A GroovyObject facade for an underlying MBean which acts like a normal groovy object but which is actually implemented via an underlying JMX MBean. Properties and normal method invocations delegate to the MBeanServer to the actual MBean. Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[GroovyMBean](#GroovyMBean(javax.management.MBeanServerConnection,%20java.lang.String))([MBeanServerConnection](https://docs.oracle.com/javaee/7/api/javax/management/MBeanServerConnection.html "MBeanServerConnection") server, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") objectName)` \| \| `[GroovyMBean](#GroovyMBean(javax.management.MBeanServerConnection,%20java.lang.String,%20boolean))([MBeanServerConnection](https://docs.oracle.com/javaee/7/api/javax/management/MBeanServerConnection.html "MBeanServerConnection") server, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") objectName, boolean ignoreErrors)` \| \| `[GroovyMBean](#GroovyMBean(javax.management.MBeanServerConnection,%20javax.management.ObjectName))([MBeanServerConnection](https://docs.oracle.com/javaee/7/api/javax/management/MBeanServerConnection.html "MBeanServerConnection") server, [ObjectName](https://docs.oracle.com/javaee/7/api/javax/management/ObjectName.html "ObjectName") name)` \| \| `[GroovyMBean](#GroovyMBean(javax.management.MBeanServerConnection,%20javax.management.ObjectName,%20boolean))([MBeanServerConnection](https://docs.oracle.com/javaee/7/api/javax/management/MBeanServerConnection.html "MBeanServerConnection") server, [ObjectName](https://docs.oracle.com/javaee/7/api/javax/management/ObjectName.html "ObjectName") name, boolean ignoreErrors)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[createOperationKey](#createOperationKey(java.lang.String,%20int))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") operation, int params)`Construct a simple key based on the method name and the number of parameters \| \| \| `protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")[]` \| `[createSignature](#createSignature(javax.management.MBeanOperationInfo))([MBeanOperationInfo](https://docs.oracle.com/javaee/7/api/javax/management/MBeanOperationInfo.html "MBeanOperationInfo") info)` \| \| \| `protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[describeAttribute](#describeAttribute(javax.management.MBeanAttributeInfo))([MBeanAttributeInfo](https://docs.oracle.com/javaee/7/api/javax/management/MBeanAttributeInfo.html "MBeanAttributeInfo") attr)`Description of the specified attribute name. \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[describeAttribute](#describeAttribute(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") attributeName)`Description of the specified attribute name. \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>` \| `[describeOperation](#describeOperation(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") operationName)`Get the description of the specified operation. \| \| \| `protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[describeOperation](#describeOperation(javax.management.MBeanOperationInfo))([MBeanOperationInfo](https://docs.oracle.com/javaee/7/api/javax/management/MBeanOperationInfo.html "MBeanOperationInfo") operation)`Description of the operation. \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getProperty](#getProperty(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") property)` \| \| \| `public [MBeanInfo](https://docs.oracle.com/javaee/7/api/javax/management/MBeanInfo.html "MBeanInfo")` \| `[info](#info())()` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[invokeMethod](#invokeMethod(java.lang.String,%20java.lang.Object))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") method, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") arguments)` \| \| \| `public [Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>` \| `[listAttributeDescriptions](#listAttributeDescriptions())()`List of string representations of all of the attributes on the MBean. \| \| \| `public [Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>` \| `[listAttributeNames](#listAttributeNames())()`List of the names of each of the attributes on the MBean \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>` \| `[listAttributeValues](#listAttributeValues())()`The values of each of the attributes on the MBean \| \| \| `public [Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>` \| `[listOperationDescriptions](#listOperationDescriptions())()`Description of all of the operations available on the MBean. \| \| \| `public [Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>` \| `[listOperationNames](#listOperationNames())()`Names of all the operations available on the MBean. \| \| \| `public [ObjectName](https://docs.oracle.com/javaee/7/api/javax/management/ObjectName.html "ObjectName")` \| `[name](#name())()` \| \| \| `public [MBeanServerConnection](https://docs.oracle.com/javaee/7/api/javax/management/MBeanServerConnection.html "MBeanServerConnection")` \| `[server](#server())()` \| \| \| `public void` \| `[setProperty](#setProperty(java.lang.String,%20java.lang.Object))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") property, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[toString](#toString())()`Return an end user readable representation of the underlying MBean \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [GroovyObjectSupport](../lang/groovyobjectsupport)` \| `[getMetaClass](../lang/groovyobjectsupport#getMetaClass()), [setMetaClass](../lang/groovyobjectsupport#setMetaClass(groovy.lang.MetaClass))` \| Constructor Detail ------------------ ### public GroovyMBean([MBeanServerConnection](https://docs.oracle.com/javaee/7/api/javax/management/MBeanServerConnection.html "MBeanServerConnection") server, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") objectName) ### public GroovyMBean([MBeanServerConnection](https://docs.oracle.com/javaee/7/api/javax/management/MBeanServerConnection.html "MBeanServerConnection") server, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") objectName, boolean ignoreErrors) ### public GroovyMBean([MBeanServerConnection](https://docs.oracle.com/javaee/7/api/javax/management/MBeanServerConnection.html "MBeanServerConnection") server, [ObjectName](https://docs.oracle.com/javaee/7/api/javax/management/ObjectName.html "ObjectName") name) ### public GroovyMBean([MBeanServerConnection](https://docs.oracle.com/javaee/7/api/javax/management/MBeanServerConnection.html "MBeanServerConnection") server, [ObjectName](https://docs.oracle.com/javaee/7/api/javax/management/ObjectName.html "ObjectName") name, boolean ignoreErrors) Method Detail ------------- ### protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") createOperationKey([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") operation, int params) Construct a simple key based on the method name and the number of parameters Parameters: `operation` - - the mbean operation name `params` - - the number of parameters the operation supports Returns: simple unique identifier for a method ### protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")[] createSignature([MBeanOperationInfo](https://docs.oracle.com/javaee/7/api/javax/management/MBeanOperationInfo.html "MBeanOperationInfo") info) ### protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") describeAttribute([MBeanAttributeInfo](https://docs.oracle.com/javaee/7/api/javax/management/MBeanAttributeInfo.html "MBeanAttributeInfo") attr) Description of the specified attribute name. Parameters: `attr` - - the attribute Returns: String the description ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") describeAttribute([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") attributeName) Description of the specified attribute name. Parameters: `attributeName` - - stringified name of the attribute Returns: the description ### public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> describeOperation([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") operationName) Get the description of the specified operation. This returns a Collection since operations can be overloaded and one operationName can have multiple forms. Parameters: `operationName` - the name of the operation to describe Returns: Collection of operation description ### protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") describeOperation([MBeanOperationInfo](https://docs.oracle.com/javaee/7/api/javax/management/MBeanOperationInfo.html "MBeanOperationInfo") operation) Description of the operation. Parameters: `operation` - the operation to describe Returns: pretty-printed description ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getProperty([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") property) ### public [MBeanInfo](https://docs.oracle.com/javaee/7/api/javax/management/MBeanInfo.html "MBeanInfo") info() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") invokeMethod([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") method, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") arguments) ### public [Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> listAttributeDescriptions() List of string representations of all of the attributes on the MBean. Returns: list of descriptions of each attribute on the mbean ### public [Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> listAttributeNames() List of the names of each of the attributes on the MBean Returns: list of attribute names ### public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> listAttributeValues() The values of each of the attributes on the MBean Returns: list of values of each attribute ### public [Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> listOperationDescriptions() Description of all of the operations available on the MBean. Returns: full description of each operation on the MBean ### public [Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> listOperationNames() Names of all the operations available on the MBean. Returns: all the operations on the MBean ### public [ObjectName](https://docs.oracle.com/javaee/7/api/javax/management/ObjectName.html "ObjectName") name() ### public [MBeanServerConnection](https://docs.oracle.com/javaee/7/api/javax/management/MBeanServerConnection.html "MBeanServerConnection") server() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void setProperty([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") property, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") toString() Return an end user readable representation of the underlying MBean Returns: the user readable description	programming_docs
groovy [Groovy] Class JmxBeansFactory [Groovy] Class JmxBeansFactory ============================== * groovy.jmx.builder.JmxBeansFactory ``` class JmxBeansFactory extends [AbstractFactory](../../util/abstractfactory "AbstractFactory") ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[JmxBeansFactory](#JmxBeansFactory())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `boolean` \| `[isLeaf](#isLeaf())()` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") nodeName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") nodeParam, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") nodeAttribs)` \| \| \| `boolean` \| `[onHandleNodeAttributes](#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") nodeAttribs)` \| \| \| `void` \| `[onNodeCompleted](#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parentNode, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") thisNode)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractFactory](../../util/abstractfactory "AbstractFactory")` \| `[setParent](../../util/abstractfactory#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setParent"), [isLeaf](../../util/abstractfactory#isLeaf() "isLeaf"), [onNodeChildren](../../util/abstractfactory#onNodeChildren(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20groovy.lang.Closure) "onNodeChildren"), [setChild](../../util/abstractfactory#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setChild"), [onNodeCompleted](../../util/abstractfactory#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "onNodeCompleted"), [onFactoryRegistration](../../util/abstractfactory#onFactoryRegistration(groovy.util.FactoryBuilderSupport,%20java.lang.String,%20java.lang.String) "onFactoryRegistration"), [isHandlesNodeChildren](../../util/abstractfactory#isHandlesNodeChildren() "isHandlesNodeChildren"), [onHandleNodeAttributes](../../util/abstractfactory#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map) "onHandleNodeAttributes"), [wait](../../util/abstractfactory#wait(long,%20int) "wait"), [wait](../../util/abstractfactory#wait() "wait"), [wait](../../util/abstractfactory#wait(long) "wait"), [equals](../../util/abstractfactory#equals(java.lang.Object) "equals"), [toString](../../util/abstractfactory#toString() "toString"), [hashCode](../../util/abstractfactory#hashCode() "hashCode"), [getClass](../../util/abstractfactory#getClass() "getClass"), [notify](../../util/abstractfactory#notify() "notify"), [notifyAll](../../util/abstractfactory#notifyAll() "notifyAll"), [newInstance](../../util/abstractfactory#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map) "newInstance")` \| Constructor Detail ------------------ ### JmxBeansFactory() Method Detail ------------- ### boolean isLeaf() ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") nodeName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") nodeParam, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") nodeAttribs) ### boolean onHandleNodeAttributes([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") nodeAttribs) ### void onNodeCompleted([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parentNode, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") thisNode) groovy [Groovy] Class JmxBeanExportFactory [Groovy] Class JmxBeanExportFactory =================================== * groovy.jmx.builder.JmxBeanExportFactory ``` class JmxBeanExportFactory extends [AbstractFactory](../../util/abstractfactory "AbstractFactory") ``` This factory returns a container node for all other nodes that are used to collect meta data for resources that are exported to the MBeanServer for management. Supported syntax: ``` def jmx = new JmxBuilder() jmx.export(registrationPolicy:"replace\|ignore\|error") { bean(...) } ``` registrationPolicy indicates how resources will be registered: "replace" - replaces existing bean, "ignore" - ignores the registration request if bean already exists. "error" - throws error if bean is already registered. Properties Summary ------------------ Properties \| Type \| Name and description \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[registrationPolicy](#registrationPolicy)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[JmxBeanExportFactory](#JmxBeanExportFactory())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `boolean` \| `[isLeaf](#isLeaf())()` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") nodeName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") nodeArgs, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") nodeAttribs)` \| \| \| `boolean` \| `[onHandleNodeAttributes](#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") nodeAttribs)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractFactory](../../util/abstractfactory "AbstractFactory")` \| `[setParent](../../util/abstractfactory#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setParent"), [isLeaf](../../util/abstractfactory#isLeaf() "isLeaf"), [onNodeChildren](../../util/abstractfactory#onNodeChildren(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20groovy.lang.Closure) "onNodeChildren"), [setChild](../../util/abstractfactory#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setChild"), [onNodeCompleted](../../util/abstractfactory#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "onNodeCompleted"), [onFactoryRegistration](../../util/abstractfactory#onFactoryRegistration(groovy.util.FactoryBuilderSupport,%20java.lang.String,%20java.lang.String) "onFactoryRegistration"), [isHandlesNodeChildren](../../util/abstractfactory#isHandlesNodeChildren() "isHandlesNodeChildren"), [onHandleNodeAttributes](../../util/abstractfactory#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map) "onHandleNodeAttributes"), [wait](../../util/abstractfactory#wait(long,%20int) "wait"), [wait](../../util/abstractfactory#wait() "wait"), [wait](../../util/abstractfactory#wait(long) "wait"), [equals](../../util/abstractfactory#equals(java.lang.Object) "equals"), [toString](../../util/abstractfactory#toString() "toString"), [hashCode](../../util/abstractfactory#hashCode() "hashCode"), [getClass](../../util/abstractfactory#getClass() "getClass"), [notify](../../util/abstractfactory#notify() "notify"), [notifyAll](../../util/abstractfactory#notifyAll() "notifyAll"), [newInstance](../../util/abstractfactory#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map) "newInstance")` \| Property Detail --------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") registrationPolicy Constructor Detail ------------------ ### JmxBeanExportFactory() Method Detail ------------- ### boolean isLeaf() ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") nodeName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") nodeArgs, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") nodeAttribs) ### boolean onHandleNodeAttributes([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") nodeAttribs) groovy [Java] Interface JmxEventEmitterMBean [Java] Interface JmxEventEmitterMBean ===================================== ``` public interface JmxEventEmitterMBean ``` This is the management interface for JmxEventEmitter. This MBean is used internally by JmxBuilder to broadcast events to registered listeners of the underlying MBeanServer. See Also: [JmxEventEmitter](jmxeventemitter "JmxEventEmitter") Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getEvent](#getEvent())()`Getter - returns event thrown by emitter. \| \| \| `public long` \| `[send](#send(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") data)`Method called to dispatch event on event bus. \| \| \| `public void` \| `[setEvent](#setEvent(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") event)`Setter - sets event thrown by Emitter. \| Method Detail ------------- ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getEvent() Getter - returns event thrown by emitter. Returns: event type string ### public long send([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") data) Method called to dispatch event on event bus. Parameters: `data` - - data sent to listeners. Returns: - a sequence id generated for event. ### public void setEvent([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") event) Setter - sets event thrown by Emitter. Parameters: `event` - - event type string groovy [Java] Class JmxEventListener [Java] Class JmxEventListener ============================= * groovy.jmx.builder.JmxEventListener All Implemented Interfaces and Traits: [NotificationListener](https://docs.oracle.com/javaee/7/api/javax/management/NotificationListener.html "NotificationListener") ``` public class JmxEventListener extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") implements [NotificationListener](https://docs.oracle.com/javaee/7/api/javax/management/NotificationListener.html "NotificationListener") ``` The JmxEventListener class is used by the builder to listen to events on the event bus. It is used internally by JmxBuilder to handle attribute-change and operation-invoke events on the bean() node. See Also: [JmxBeanFactory](jmxbeanfactory "JmxBeanFactory") Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public static [JmxEventListener](jmxeventlistener)` \| `[getListener](#getListener())()`Factory method that returns an instance of the listener. \| \| \| `public void` \| `[handleNotification](#handleNotification(javax.management.Notification,%20java.lang.Object))([Notification](https://docs.oracle.com/javaee/7/api/javax/management/Notification.html "Notification") notification, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") handback)`This is the implemented method for NotificationListener. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### public static [JmxEventListener](jmxeventlistener) getListener() Factory method that returns an instance of the listener. Returns: - JmxEventListener instance. ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void handleNotification([Notification](https://docs.oracle.com/javaee/7/api/javax/management/Notification.html "Notification") notification, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") handback) This is the implemented method for NotificationListener. It is called by an event emitter to dispatch JMX events to listeners. Here it handles internal JmxBuilder events. Parameters: `notification` - the notification object passed to closure used to handle JmxBuilder events. `handback` - - In this case, the handback is the closure to execute when the event is handled. groovy [Groovy] Class JmxServerConnectorFactory [Groovy] Class JmxServerConnectorFactory ======================================== * groovy.jmx.builder.JmxServerConnectorFactory ``` class JmxServerConnectorFactory extends [AbstractFactory](../../util/abstractfactory "AbstractFactory") ``` This is the server connector factory used for node JmxBuilder.connectorServer(). A call to this node returns an instance of JMXConnectorServer interface (rmi default). Possible syntax: ``` JmxBuilder.connectorServer( protocol:"rmi", host:"...", port:1099, url:"...", properties:[ "authenticate":true\|false, "passwordFile":"...", "accessFile":"...", "sslEnabled" : true \| false ... ] ) ``` See Also: [JMXConnector](http://java.sun.com/j2se/1.5.0/docs/api/javax/management/remote/JMXConnector.html) Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[JmxServerConnectorFactory](#JmxServerConnectorFactory())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `boolean` \| `[isLeaf](#isLeaf())()` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") nodeName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") nodeArgs, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") nodeAttribs)` \| \| \| `boolean` \| `[onHandleNodeAttributes](#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") nodeAttribs)` \| \| \| `void` \| `[onNodeCompleted](#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parentNode, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") thisNode)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractFactory](../../util/abstractfactory "AbstractFactory")` \| `[setParent](../../util/abstractfactory#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setParent"), [isLeaf](../../util/abstractfactory#isLeaf() "isLeaf"), [onNodeChildren](../../util/abstractfactory#onNodeChildren(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20groovy.lang.Closure) "onNodeChildren"), [setChild](../../util/abstractfactory#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setChild"), [onNodeCompleted](../../util/abstractfactory#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "onNodeCompleted"), [onFactoryRegistration](../../util/abstractfactory#onFactoryRegistration(groovy.util.FactoryBuilderSupport,%20java.lang.String,%20java.lang.String) "onFactoryRegistration"), [isHandlesNodeChildren](../../util/abstractfactory#isHandlesNodeChildren() "isHandlesNodeChildren"), [onHandleNodeAttributes](../../util/abstractfactory#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map) "onHandleNodeAttributes"), [wait](../../util/abstractfactory#wait(long,%20int) "wait"), [wait](../../util/abstractfactory#wait() "wait"), [wait](../../util/abstractfactory#wait(long) "wait"), [equals](../../util/abstractfactory#equals(java.lang.Object) "equals"), [toString](../../util/abstractfactory#toString() "toString"), [hashCode](../../util/abstractfactory#hashCode() "hashCode"), [getClass](../../util/abstractfactory#getClass() "getClass"), [notify](../../util/abstractfactory#notify() "notify"), [notifyAll](../../util/abstractfactory#notifyAll() "notifyAll"), [newInstance](../../util/abstractfactory#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map) "newInstance")` \| Constructor Detail ------------------ ### JmxServerConnectorFactory() Method Detail ------------- ### boolean isLeaf() ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") nodeName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") nodeArgs, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") nodeAttribs) ### boolean onHandleNodeAttributes([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") nodeAttribs) ### void onNodeCompleted([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parentNode, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") thisNode)	programming_docs
groovy [Groovy] Class JmxBuilder [Groovy] Class JmxBuilder ========================= * groovy.jmx.builder.JmxBuilder ``` class JmxBuilder extends [FactoryBuilderSupport](../../util/factorybuildersupport "FactoryBuilderSupport") ``` This is JmxBuilder's factory builder class. It is the parent node to all other children nodes supported by JmxBuilder. Inherited fields \| Fields inherited from class \| Fields \| \| `class [FactoryBuilderSupport](../../util/factorybuildersupport "FactoryBuilderSupport")` \| `CURRENT_FACTORY, PARENT_FACTORY, PARENT_NODE, CURRENT_NODE, PARENT_CONTEXT, PARENT_NAME, CURRENT_NAME, OWNER, PARENT_BUILDER, CURRENT_BUILDER, CHILD_BUILDER, SCRIPT_CLASS_NAME` \| Properties Summary ------------------ Properties \| Type \| Name and description \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[defaultJmxNameDomain](#defaultJmxNameDomain)` \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[defaultJmxNameType](#defaultJmxNameType)` \| \| `[MBeanServerConnection](https://docs.oracle.com/javaee/7/api/javax/management/MBeanServerConnection.html "MBeanServerConnection")` \| `[mBeanServer](#mBeanServer)` \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[mode](#mode)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[JmxBuilder](#JmxBuilder())()` \| \| `[JmxBuilder](#JmxBuilder(javax.management.MBeanServerConnection))([MBeanServerConnection](https://docs.oracle.com/javaee/7/api/javax/management/MBeanServerConnection.html "MBeanServerConnection") svrConnection)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getDefaultJmxNameDomain](#getDefaultJmxNameDomain())()` \| \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getDefaultJmxNameType](#getDefaultJmxNameType())()` \| \| \| `[MBeanServerConnection](https://docs.oracle.com/javaee/7/api/javax/management/MBeanServerConnection.html "MBeanServerConnection")` \| `[getMBeanServer](#getMBeanServer())()` \| \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getMode](#getMode())()` \| \| \| `protected void` \| `[registerFactories](#registerFactories())()` \| \| \| `protected [Factory](../../util/factory)` \| `[resolveFactory](#resolveFactory(java.lang.Object,%20java.util.Map,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| \| \| `void` \| `[setDefaultJmxNameDomain](#setDefaultJmxNameDomain(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") domain)` \| \| \| `void` \| `[setDefaultJmxNameType](#setDefaultJmxNameType(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") type)` \| \| \| `void` \| `[setMBeanServer](#setMBeanServer(javax.management.MBeanServerConnection))([MBeanServerConnection](https://docs.oracle.com/javaee/7/api/javax/management/MBeanServerConnection.html "MBeanServerConnection") svr)` \| \| \| `void` \| `[setMode](#setMode(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") mode)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [FactoryBuilderSupport](../../util/factorybuildersupport "FactoryBuilderSupport")` \| `[getName](../../util/factorybuildersupport#getName(java.lang.String) "getName"), [getProperty](../../util/factorybuildersupport#getProperty(java.lang.String) "getProperty"), [setProperty](../../util/factorybuildersupport#setProperty(java.lang.String,%20java.lang.Object) "setProperty"), [getContext](../../util/factorybuildersupport#getContext() "getContext"), [build](../../util/factorybuildersupport#build(java.lang.String,%20groovy.lang.GroovyClassLoader) "build"), [build](../../util/factorybuildersupport#build(java.lang.Class) "build"), [build](../../util/factorybuildersupport#build(groovy.lang.Script) "build"), [dispose](../../util/factorybuildersupport#dispose() "dispose"), [invokeMethod](../../util/factorybuildersupport#invokeMethod(java.lang.String,%20java.lang.Object) "invokeMethod"), [invokeMethod](../../util/factorybuildersupport#invokeMethod(java.lang.String) "invokeMethod"), [getCurrent](../../util/factorybuildersupport#getCurrent() "getCurrent"), [registerFactory](../../util/factorybuildersupport#registerFactory(java.lang.String,%20groovy.util.Factory) "registerFactory"), [registerFactory](../../util/factorybuildersupport#registerFactory(java.lang.String,%20java.lang.String,%20groovy.util.Factory) "registerFactory"), [getVariable](../../util/factorybuildersupport#getVariable(java.lang.String) "getVariable"), [setVariable](../../util/factorybuildersupport#setVariable(java.lang.String,%20java.lang.Object) "setVariable"), [getVariables](../../util/factorybuildersupport#getVariables() "getVariables"), [getParentNode](../../util/factorybuildersupport#getParentNode() "getParentNode"), [getCurrentName](../../util/factorybuildersupport#getCurrentName() "getCurrentName"), [autoRegisterNodes](../../util/factorybuildersupport#autoRegisterNodes() "autoRegisterNodes"), [getParentName](../../util/factorybuildersupport#getParentName() "getParentName"), [getContextAttribute](../../util/factorybuildersupport#getContextAttribute(java.lang.String) "getContextAttribute"), [registerBeanFactory](../../util/factorybuildersupport#registerBeanFactory(java.lang.String,%20java.lang.String,%20java.lang.Class) "registerBeanFactory"), [registerBeanFactory](../../util/factorybuildersupport#registerBeanFactory(java.lang.String,%20java.lang.Class) "registerBeanFactory"), [getPostInstantiateDelegates](../../util/factorybuildersupport#getPostInstantiateDelegates() "getPostInstantiateDelegates"), [getLocalExplicitMethods](../../util/factorybuildersupport#getLocalExplicitMethods() "getLocalExplicitMethods"), [getPostNodeCompletionDelegates](../../util/factorybuildersupport#getPostNodeCompletionDelegates() "getPostNodeCompletionDelegates"), [getRegistrationGroupItems](../../util/factorybuildersupport#getRegistrationGroupItems(java.lang.String) "getRegistrationGroupItems"), [getMethodMissingDelegate](../../util/factorybuildersupport#getMethodMissingDelegate() "getMethodMissingDelegate"), [getPropertyMissingDelegate](../../util/factorybuildersupport#getPropertyMissingDelegate() "getPropertyMissingDelegate"), [setPropertyMissingDelegate](../../util/factorybuildersupport#setPropertyMissingDelegate(groovy.lang.Closure) "setPropertyMissingDelegate"), [addAttributeDelegate](../../util/factorybuildersupport#addAttributeDelegate(groovy.lang.Closure) "addAttributeDelegate"), [addPostInstantiateDelegate](../../util/factorybuildersupport#addPostInstantiateDelegate(groovy.lang.Closure) "addPostInstantiateDelegate"), [getRegistrationGroups](../../util/factorybuildersupport#getRegistrationGroups() "getRegistrationGroups"), [registerExplicitProperty](../../util/factorybuildersupport#registerExplicitProperty(java.lang.String,%20groovy.lang.Closure,%20groovy.lang.Closure) "registerExplicitProperty"), [registerExplicitProperty](../../util/factorybuildersupport#registerExplicitProperty(java.lang.String,%20java.lang.String,%20groovy.lang.Closure,%20groovy.lang.Closure) "registerExplicitProperty"), [getExplicitProperties](../../util/factorybuildersupport#getExplicitProperties() "getExplicitProperties"), [getLocalExplicitProperties](../../util/factorybuildersupport#getLocalExplicitProperties() "getLocalExplicitProperties"), [setMethodMissingDelegate](../../util/factorybuildersupport#setMethodMissingDelegate(groovy.lang.Closure) "setMethodMissingDelegate"), [registerExplicitMethod](../../util/factorybuildersupport#registerExplicitMethod(java.lang.String,%20groovy.lang.Closure) "registerExplicitMethod"), [registerExplicitMethod](../../util/factorybuildersupport#registerExplicitMethod(java.lang.String,%20java.lang.String,%20groovy.lang.Closure) "registerExplicitMethod"), [addPostNodeCompletionDelegate](../../util/factorybuildersupport#addPostNodeCompletionDelegate(groovy.lang.Closure) "addPostNodeCompletionDelegate"), [removePostInstantiateDelegate](../../util/factorybuildersupport#removePostInstantiateDelegate(groovy.lang.Closure) "removePostInstantiateDelegate"), [removeAttributeDelegate](../../util/factorybuildersupport#removeAttributeDelegate(groovy.lang.Closure) "removeAttributeDelegate"), [getNameMappingClosure](../../util/factorybuildersupport#getNameMappingClosure() "getNameMappingClosure"), [getPreInstantiateDelegates](../../util/factorybuildersupport#getPreInstantiateDelegates() "getPreInstantiateDelegates"), [addPreInstantiateDelegate](../../util/factorybuildersupport#addPreInstantiateDelegate(groovy.lang.Closure) "addPreInstantiateDelegate"), [getAttributeDelegates](../../util/factorybuildersupport#getAttributeDelegates() "getAttributeDelegates"), [removePreInstantiateDelegate](../../util/factorybuildersupport#removePreInstantiateDelegate(groovy.lang.Closure) "removePreInstantiateDelegate"), [removePostNodeCompletionDelegate](../../util/factorybuildersupport#removePostNodeCompletionDelegate(groovy.lang.Closure) "removePostNodeCompletionDelegate"), [setNameMappingClosure](../../util/factorybuildersupport#setNameMappingClosure(groovy.lang.Closure) "setNameMappingClosure"), [checkValueIsTypeNotString](../../util/factorybuildersupport#checkValueIsTypeNotString(java.lang.Object,%20java.lang.Object,%20java.lang.Class) "checkValueIsTypeNotString"), [getDisposalClosures](../../util/factorybuildersupport#getDisposalClosures() "getDisposalClosures"), [getChildBuilder](../../util/factorybuildersupport#getChildBuilder() "getChildBuilder"), [getFactories](../../util/factorybuildersupport#getFactories() "getFactories"), [getExplicitMethods](../../util/factorybuildersupport#getExplicitMethods() "getExplicitMethods"), [getParentFactory](../../util/factorybuildersupport#getParentFactory() "getParentFactory"), [getCurrentBuilder](../../util/factorybuildersupport#getCurrentBuilder() "getCurrentBuilder"), [withBuilder](../../util/factorybuildersupport#withBuilder(groovy.util.FactoryBuilderSupport,%20groovy.lang.Closure) "withBuilder"), [withBuilder](../../util/factorybuildersupport#withBuilder(groovy.util.FactoryBuilderSupport,%20java.lang.String,%20groovy.lang.Closure) "withBuilder"), [withBuilder](../../util/factorybuildersupport#withBuilder(java.util.Map,%20groovy.util.FactoryBuilderSupport,%20java.lang.String,%20groovy.lang.Closure) "withBuilder"), [getCurrentFactory](../../util/factorybuildersupport#getCurrentFactory() "getCurrentFactory"), [checkValueIsNull](../../util/factorybuildersupport#checkValueIsNull(java.lang.Object,%20java.lang.Object) "checkValueIsNull"), [checkValueIsType](../../util/factorybuildersupport#checkValueIsType(java.lang.Object,%20java.lang.Object,%20java.lang.Class) "checkValueIsType"), [getParentContext](../../util/factorybuildersupport#getParentContext() "getParentContext"), [getLocalFactories](../../util/factorybuildersupport#getLocalFactories() "getLocalFactories"), [addDisposalClosure](../../util/factorybuildersupport#addDisposalClosure(groovy.lang.Closure) "addDisposalClosure"), [hasVariable](../../util/factorybuildersupport#hasVariable(java.lang.String) "hasVariable"), [removeVariable](../../util/factorybuildersupport#removeVariable(java.lang.String) "removeVariable"), [setMetaClass](../../util/factorybuildersupport#setMetaClass(groovy.lang.MetaClass) "setMetaClass"), [getMetaClass](../../util/factorybuildersupport#getMetaClass() "getMetaClass"), [wait](../../util/factorybuildersupport#wait(long,%20int) "wait"), [wait](../../util/factorybuildersupport#wait() "wait"), [wait](../../util/factorybuildersupport#wait(long) "wait"), [equals](../../util/factorybuildersupport#equals(java.lang.Object) "equals"), [toString](../../util/factorybuildersupport#toString() "toString"), [hashCode](../../util/factorybuildersupport#hashCode() "hashCode"), [getClass](../../util/factorybuildersupport#getClass() "getClass"), [notify](../../util/factorybuildersupport#notify() "notify"), [notifyAll](../../util/factorybuildersupport#notifyAll() "notifyAll")` \| Property Detail --------------- ### [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") defaultJmxNameDomain ### [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") defaultJmxNameType ### [MBeanServerConnection](https://docs.oracle.com/javaee/7/api/javax/management/MBeanServerConnection.html "MBeanServerConnection") mBeanServer ### [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") mode Constructor Detail ------------------ ### JmxBuilder() ### JmxBuilder([MBeanServerConnection](https://docs.oracle.com/javaee/7/api/javax/management/MBeanServerConnection.html "MBeanServerConnection") svrConnection) Method Detail ------------- ### [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getDefaultJmxNameDomain() ### [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getDefaultJmxNameType() ### [MBeanServerConnection](https://docs.oracle.com/javaee/7/api/javax/management/MBeanServerConnection.html "MBeanServerConnection") getMBeanServer() ### [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getMode() ### protected void registerFactories() ### protected [Factory](../../util/factory) resolveFactory([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) ### void setDefaultJmxNameDomain([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") domain) ### void setDefaultJmxNameType([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") type) ### void setMBeanServer([MBeanServerConnection](https://docs.oracle.com/javaee/7/api/javax/management/MBeanServerConnection.html "MBeanServerConnection") svr) ### void setMode([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") mode) groovy [Java] Class JmxBuilderModelMBean [Java] Class JmxBuilderModelMBean ================================= * groovy.jmx.builder.JmxBuilderModelMBean All Implemented Interfaces and Traits: [NotificationListener](https://docs.oracle.com/javaee/7/api/javax/management/NotificationListener.html "NotificationListener") ``` public class JmxBuilderModelMBean extends [RequiredModelMBean](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/RequiredModelMBean.html "RequiredModelMBean") implements [NotificationListener](https://docs.oracle.com/javaee/7/api/javax/management/NotificationListener.html "NotificationListener") ``` The JmxBuilderModelMBean is the MBean class that proxies exported POGO/POJO inside the MBeanServer. When JmxBuilder exports an object instance, an instance of this class is created and exported inside the MBeanServer. Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[JmxBuilderModelMBean](#JmxBuilderModelMBean(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") objectRef)` \| \| `[JmxBuilderModelMBean](#JmxBuilderModelMBean())()` \| \| `[JmxBuilderModelMBean](#JmxBuilderModelMBean(javax.management.modelmbean.ModelMBeanInfo))([ModelMBeanInfo](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/ModelMBeanInfo.html "ModelMBeanInfo") mbi)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public void` \| `[addEventListeners](#addEventListeners(javax.management.MBeanServer,%20Map))([MBeanServer](https://docs.oracle.com/javaee/7/api/javax/management/MBeanServer.html "MBeanServer") server, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")>> descriptor)`Sets up event listeners for this MBean as described in the descriptor. \| \| \| `public void` \| `[addOperationCallListeners](#addOperationCallListeners(Map))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")>>> descriptor)`Registers listeners for operation calls (i.e. method, getter, and setter calls) when invoked on this bean from the MBeanServer. \| \| \| `public void` \| `[handleNotification](#handleNotification(javax.management.Notification,%20java.lang.Object))([Notification](https://docs.oracle.com/javaee/7/api/javax/management/Notification.html "Notification") note, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") handback)` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[invoke](#invoke(java.lang.String,%20java.lang.Object,%20java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") opName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] opArgs, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")[] signature)` \| \| \| `public void` \| `[setManagedResource](#setManagedResource(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") obj)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [RequiredModelMBean](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/RequiredModelMBean.html "RequiredModelMBean")` \| `[invoke](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/RequiredModelMBean.html#invoke(java.lang.String,%20%5BLjava.lang.Object;,%20%5BLjava.lang.String;) "invoke"), [load](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/RequiredModelMBean.html#load() "load"), [store](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/RequiredModelMBean.html#store() "store"), [getAttributes](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/RequiredModelMBean.html#getAttributes(%5BLjava.lang.String;) "getAttributes"), [setAttribute](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/RequiredModelMBean.html#setAttribute(javax.management.Attribute) "setAttribute"), [getAttribute](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/RequiredModelMBean.html#getAttribute(java.lang.String) "getAttribute"), [getNotificationInfo](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/RequiredModelMBean.html#getNotificationInfo() "getNotificationInfo"), [getMBeanInfo](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/RequiredModelMBean.html#getMBeanInfo() "getMBeanInfo"), [sendNotification](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/RequiredModelMBean.html#sendNotification(javax.management.Notification) "sendNotification"), [sendNotification](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/RequiredModelMBean.html#sendNotification(java.lang.String) "sendNotification"), [addNotificationListener](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/RequiredModelMBean.html#addNotificationListener(javax.management.NotificationListener,%20javax.management.NotificationFilter,%20java.lang.Object) "addNotificationListener"), [removeNotificationListener](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/RequiredModelMBean.html#removeNotificationListener(javax.management.NotificationListener,%20javax.management.NotificationFilter,%20java.lang.Object) "removeNotificationListener"), [removeNotificationListener](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/RequiredModelMBean.html#removeNotificationListener(javax.management.NotificationListener) "removeNotificationListener"), [setAttributes](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/RequiredModelMBean.html#setAttributes(javax.management.AttributeList) "setAttributes"), [preRegister](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/RequiredModelMBean.html#preRegister(javax.management.MBeanServer,%20javax.management.ObjectName) "preRegister"), [postRegister](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/RequiredModelMBean.html#postRegister(java.lang.Boolean) "postRegister"), [preDeregister](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/RequiredModelMBean.html#preDeregister() "preDeregister"), [postDeregister](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/RequiredModelMBean.html#postDeregister() "postDeregister"), [setModelMBeanInfo](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/RequiredModelMBean.html#setModelMBeanInfo(javax.management.modelmbean.ModelMBeanInfo) "setModelMBeanInfo"), [sendAttributeChangeNotification](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/RequiredModelMBean.html#sendAttributeChangeNotification(javax.management.AttributeChangeNotification) "sendAttributeChangeNotification"), [sendAttributeChangeNotification](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/RequiredModelMBean.html#sendAttributeChangeNotification(javax.management.Attribute,%20javax.management.Attribute) "sendAttributeChangeNotification"), [setManagedResource](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/RequiredModelMBean.html#setManagedResource(java.lang.Object,%20java.lang.String) "setManagedResource"), [addAttributeChangeNotificationListener](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/RequiredModelMBean.html#addAttributeChangeNotificationListener(javax.management.NotificationListener,%20java.lang.String,%20java.lang.Object) "addAttributeChangeNotificationListener"), [removeAttributeChangeNotificationListener](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/RequiredModelMBean.html#removeAttributeChangeNotificationListener(javax.management.NotificationListener,%20java.lang.String) "removeAttributeChangeNotificationListener"), [wait](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/RequiredModelMBean.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/RequiredModelMBean.html#wait() "wait"), [wait](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/RequiredModelMBean.html#wait(long) "wait"), [equals](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/RequiredModelMBean.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/RequiredModelMBean.html#toString() "toString"), [hashCode](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/RequiredModelMBean.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/RequiredModelMBean.html#getClass() "getClass"), [notify](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/RequiredModelMBean.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/RequiredModelMBean.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public JmxBuilderModelMBean([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") objectRef) ### public JmxBuilderModelMBean() ### public JmxBuilderModelMBean([ModelMBeanInfo](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/ModelMBeanInfo.html "ModelMBeanInfo") mbi) Method Detail ------------- ### public void addEventListeners([MBeanServer](https://docs.oracle.com/javaee/7/api/javax/management/MBeanServer.html "MBeanServer") server, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")>> descriptor) Sets up event listeners for this MBean as described in the descriptor. The descriptor contains a map with layout {item -> Map[event:"...", from:ObjectName, callback:&Closure],...,} Parameters: `server` - the MBeanServer is to be registered. `descriptor` - a map containing info about the event ### public void addOperationCallListeners([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")>>> descriptor) Registers listeners for operation calls (i.e. method, getter, and setter calls) when invoked on this bean from the MBeanServer. Descriptor should contain a map with layout `item -> [Map[methodListener:[target:"", tpe:"", callback:&Closure], ... ,]]` Parameters: `descriptor` - MetaMap descriptor containing description of operation call listeners ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void handleNotification([Notification](https://docs.oracle.com/javaee/7/api/javax/management/Notification.html "Notification") note, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") handback) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") invoke([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") opName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] opArgs, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")[] signature) ### public void setManagedResource([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") obj)	programming_docs
groovy [Groovy] Class JmxOperationInfoManager [Groovy] Class JmxOperationInfoManager ====================================== * groovy.jmx.builder.JmxOperationInfoManager ``` class JmxOperationInfoManager extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` This class is responsible for assembling JMX Operation Info from the meta map. It cycles through the provided meta map from the bean() node and generate JMX Info objects used to expose information in the MBeanServer. See Also: [JmxMetaMapBuilder](jmxmetamapbuilder "JmxMetaMapBuilder") Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[JmxOperationInfoManager](#JmxOperationInfoManager())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `static [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<MBeanParameterInfo>` \| `[buildParamInfosFromMaps](#buildParamInfosFromMaps(java.util.Map))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") metaMap)`Build an array of MBeanParameterInfo from the operation's meta map. \| \| \| `static [ModelMBeanOperationInfo](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/ModelMBeanOperationInfo.html "ModelMBeanOperationInfo")` \| `[createGetterOperationInfoFromProperty](#createGetterOperationInfoFromProperty(groovy.lang.MetaProperty))([MetaProperty](../../lang/metaproperty) prop)`Returns a MBean operation info for getter operation specified by the MetaProperty. \| \| \| `static [ModelMBeanOperationInfo](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/ModelMBeanOperationInfo.html "ModelMBeanOperationInfo")` \| `[createSetterOperationInfoFromProperty](#createSetterOperationInfoFromProperty(groovy.lang.MetaProperty))([MetaProperty](../../lang/metaproperty) prop)`Returns a MBean operation info for setter operation specified by the MetaProperty. \| \| \| `static [ModelMBeanConstructorInfo](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/ModelMBeanConstructorInfo.html "ModelMBeanConstructorInfo")` \| `[getConstructorInfoFromMap](#getConstructorInfoFromMap(java.util.Map))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") map)`This method extracts ModelMBeanConstructorInfo from provided meta map. \| \| \| `static [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<ModelMBeanConstructorInfo>` \| `[getConstructorInfosFromMap](#getConstructorInfosFromMap(java.util.Map))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") metaMap)`This method extracts an array of MBeanConstructorInfo from a list of meta maps. \| \| \| `static [ModelMBeanOperationInfo](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/ModelMBeanOperationInfo.html "ModelMBeanOperationInfo")` \| `[getOperationInfoFromMap](#getOperationInfoFromMap(java.util.Map))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") map)`Generates a ModelMBeanOperationInfo object from a meta map provided. \| \| \| `static [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<ModelMBeanOperationInfo>` \| `[getOperationInfosFromMap](#getOperationInfosFromMap(java.util.Map))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") metaMap)`This method extracts an array of MBeanOperationInfo from a list of meta maps. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### JmxOperationInfoManager() Method Detail ------------- ### static [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<MBeanParameterInfo> buildParamInfosFromMaps([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") metaMap) Build an array of MBeanParameterInfo from the operation's meta map. Parameters: `the` - meta map containing the param info Returns: an array of JMX MBeanParameterInfo ### static [ModelMBeanOperationInfo](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/ModelMBeanOperationInfo.html "ModelMBeanOperationInfo") createGetterOperationInfoFromProperty([MetaProperty](../../lang/metaproperty) prop) Returns a MBean operation info for getter operation specified by the MetaProperty. Since no meta map is provided, this method will generate all default descriptor values to describe the operation. Parameters: `prop` - - the property object on the POGO/POJO that represents a getter Returns: a ModelMBeanOperation info built ### static [ModelMBeanOperationInfo](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/ModelMBeanOperationInfo.html "ModelMBeanOperationInfo") createSetterOperationInfoFromProperty([MetaProperty](../../lang/metaproperty) prop) Returns a MBean operation info for setter operation specified by the MetaProperty. Since no meta data is provided, this method will generate all default descriptor values to describe operation. Parameters: `prop` - - the property object on the POGO/POJO that represents a setter Returns: a ModelMBeanOperation info built ### static [ModelMBeanConstructorInfo](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/ModelMBeanConstructorInfo.html "ModelMBeanConstructorInfo") getConstructorInfoFromMap([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") map) This method extracts ModelMBeanConstructorInfo from provided meta map. It also iterates over any parameters and builds the necessary MBeanParameterInfo array. Parameters: `meta` - map containing descriptor information Returns: the fully realized ModelMBeanConstructorInfo for the provided constructor reference. ### static [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<ModelMBeanConstructorInfo> getConstructorInfosFromMap([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") metaMap) This method extracts an array of MBeanConstructorInfo from a list of meta maps. Parameters: `list` - of meta maps Returns: array of ModelMBeanConstructorInfo ### static [ModelMBeanOperationInfo](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/ModelMBeanOperationInfo.html "ModelMBeanOperationInfo") getOperationInfoFromMap([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") map) Generates a ModelMBeanOperationInfo object from a meta map provided. Parameters: `the` - meta map for the method Returns: the generated ModelMBeanOperationInfo ### static [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<ModelMBeanOperationInfo> getOperationInfosFromMap([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") metaMap) This method extracts an array of MBeanOperationInfo from a list of meta maps. Parameters: `list` - of meta maps Returns: array of ModelMBeanOperationInfo groovy [Groovy] Class JmxBeanFactory [Groovy] Class JmxBeanFactory ============================= * groovy.jmx.builder.JmxBeanFactory ``` class JmxBeanFactory extends [AbstractFactory](../../util/abstractfactory "AbstractFactory") ``` This factory returns the bean() node. This node is used to declaratively expose a POGO/POJO to be exported to the MBeanServer for management. You can use the builder node to declare the descriptor or embed the descriptor directly in the object being exposed using static variable descriptor (or jmx). You should note that embedded descriptor takes precedence over declared builder descriptor. The following shows all of the different syntax forms supported by the node. ``` bean(instance) bean(target:instance, name:ObjectName\|"...", desc\|description:"...") bean(target:instance, server:MBeanServerConnection name:ObjectName()\|"...", desc\|description:"...", attribs\|attributes:"", attribs\|attributes:[] attribs\|attributes:["attribName1","attribName2",..."attribNameN"] attribs\|attributes:[ "attribName0":"", "attribName1":[desc\|description:"...", default:value, writable\|editable:true\|false,...] "attribName2":[onChange:{event-> // onChange event callback code here. ] ], ctors\|constructors:"", ctors\|constructors:[ "CtorName0":[], "CtorName1":["paramType1","paramType2"], "CtorName2":[ desc\|description:"...", params:[ "type0":"" "type1":[desc\|description:"...", name:"...", ] ] ] ], ops\|operations:"", ops\|operations:["opName1", "opName2", "opName3",...,"opNameN"], ops\|operations:[ "opName0":"", "opName1":["type1","type2,"type3"] "opName2":[ desc:"description", params:[ "type0":"" "type1":[desc\|description:"...", name:"...", ], "typeN":[desc\|description:"...", name:"...", ], ], ], "opName3":[ onCall:{event-> // onCall event callback code here. }] ], listeners:[ ListenerName:[ event: "eventType", from:"object name"\|ObjectName(), call:{event-> // handler code for event }], ] ) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[JmxBeanFactory](#JmxBeanFactory())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `boolean` \| `[isLeaf](#isLeaf())()` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") nodeName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") nodeParam, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") nodeAttributes)` \| \| \| `boolean` \| `[onHandleNodeAttributes](#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") nodeAttribs)` \| \| \| `void` \| `[onNodeCompleted](#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parentNode, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") thisNode)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractFactory](../../util/abstractfactory "AbstractFactory")` \| `[setParent](../../util/abstractfactory#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setParent"), [isLeaf](../../util/abstractfactory#isLeaf() "isLeaf"), [onNodeChildren](../../util/abstractfactory#onNodeChildren(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20groovy.lang.Closure) "onNodeChildren"), [setChild](../../util/abstractfactory#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setChild"), [onNodeCompleted](../../util/abstractfactory#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "onNodeCompleted"), [onFactoryRegistration](../../util/abstractfactory#onFactoryRegistration(groovy.util.FactoryBuilderSupport,%20java.lang.String,%20java.lang.String) "onFactoryRegistration"), [isHandlesNodeChildren](../../util/abstractfactory#isHandlesNodeChildren() "isHandlesNodeChildren"), [onHandleNodeAttributes](../../util/abstractfactory#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map) "onHandleNodeAttributes"), [wait](../../util/abstractfactory#wait(long,%20int) "wait"), [wait](../../util/abstractfactory#wait() "wait"), [wait](../../util/abstractfactory#wait(long) "wait"), [equals](../../util/abstractfactory#equals(java.lang.Object) "equals"), [toString](../../util/abstractfactory#toString() "toString"), [hashCode](../../util/abstractfactory#hashCode() "hashCode"), [getClass](../../util/abstractfactory#getClass() "getClass"), [notify](../../util/abstractfactory#notify() "notify"), [notifyAll](../../util/abstractfactory#notifyAll() "notifyAll"), [newInstance](../../util/abstractfactory#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map) "newInstance")` \| Constructor Detail ------------------ ### JmxBeanFactory() Method Detail ------------- ### boolean isLeaf() ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") nodeName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") nodeParam, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") nodeAttributes) ### boolean onHandleNodeAttributes([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") nodeAttribs) ### void onNodeCompleted([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parentNode, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") thisNode) groovy [Java] Class JmxBuilderException [Java] Class JmxBuilderException ================================ groovy.jmx.builder.JmxBuilderException ``` public class JmxBuilderException extends [RuntimeException](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html "RuntimeException") ``` Runtime exception used by JmxBuilder. Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[JmxBuilderException](#JmxBuilderException())()`Default constructor for exception. \| \| `[JmxBuilderException](#JmxBuilderException(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") ex)`Parameterized constructor. \| \| `[JmxBuilderException](#JmxBuilderException(java.lang.Throwable))([Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html "Throwable") ex)`Parameterized constructor. \| \| `[JmxBuilderException](#JmxBuilderException(java.lang.String,%20java.lang.Throwable))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") msg, [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html "Throwable") ex)`Parameterized constructor. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [RuntimeException](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html "RuntimeException")` \| `[printStackTrace](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html#printStackTrace() "printStackTrace"), [printStackTrace](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html#printStackTrace(java.io.PrintStream) "printStackTrace"), [printStackTrace](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html#printStackTrace(java.io.PrintWriter) "printStackTrace"), [fillInStackTrace](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html#fillInStackTrace() "fillInStackTrace"), [getCause](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html#getCause() "getCause"), [initCause](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html#initCause(java.lang.Throwable) "initCause"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html#toString() "toString"), [getMessage](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html#getMessage() "getMessage"), [getSuppressed](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html#getSuppressed() "getSuppressed"), [getLocalizedMessage](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html#getLocalizedMessage() "getLocalizedMessage"), [getStackTrace](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html#getStackTrace() "getStackTrace"), [setStackTrace](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html#setStackTrace(%5BLjava.lang.StackTraceElement;) "setStackTrace"), [addSuppressed](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html#addSuppressed(java.lang.Throwable) "addSuppressed"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html#equals(java.lang.Object) "equals"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public JmxBuilderException() Default constructor for exception. ### public JmxBuilderException([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") ex) Parameterized constructor. Parameters: `ex` - - exception message. ### public JmxBuilderException([Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html "Throwable") ex) Parameterized constructor. Parameters: `ex` - - exception thrown. ### public JmxBuilderException([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") msg, [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html "Throwable") ex) Parameterized constructor. Parameters: `msg` - - exception message. `ex` - - exception thrown.	programming_docs
groovy [Java] Class JmxEventEmitter [Java] Class JmxEventEmitter ============================ * groovy.jmx.builder.JmxEventEmitter All Implemented Interfaces and Traits: [JmxEventEmitterMBean](jmxeventemittermbean) ``` public class JmxEventEmitter extends [NotificationBroadcasterSupport](https://docs.oracle.com/javaee/7/api/javax/management/NotificationBroadcasterSupport.html "NotificationBroadcasterSupport") implements [JmxEventEmitterMBean](jmxeventemittermbean) ``` The JmxEventEmitter is a JMX Broadcaster class that is used to send generic events on the MBeanServer's event bus. It is used by the Emitter node () to send event to registered listeners. ``` def jmx = JmxBuilder() jmx.emitter(name:"Object name"\|ObjectName(), event:"event type") ... jmx.emitter.send(object) ``` See Also: [JmxEmitterFactory](jmxemitterfactory "JmxEmitterFactory") Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getEvent](#getEvent())()`Event type getter \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getMessage](#getMessage())()`Event message getter \| \| \| `public long` \| `[send](#send(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") data)`Called to broadcast message on MBeanServer event bus. \| \| \| `public void` \| `[setEvent](#setEvent(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") event)`Event type setter \| \| \| `public void` \| `[setMessage](#setMessage(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message)`Event message setter. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [NotificationBroadcasterSupport](https://docs.oracle.com/javaee/7/api/javax/management/NotificationBroadcasterSupport.html "NotificationBroadcasterSupport")` \| `[getNotificationInfo](https://docs.oracle.com/javaee/7/api/javax/management/NotificationBroadcasterSupport.html#getNotificationInfo() "getNotificationInfo"), [sendNotification](https://docs.oracle.com/javaee/7/api/javax/management/NotificationBroadcasterSupport.html#sendNotification(javax.management.Notification) "sendNotification"), [addNotificationListener](https://docs.oracle.com/javaee/7/api/javax/management/NotificationBroadcasterSupport.html#addNotificationListener(javax.management.NotificationListener,%20javax.management.NotificationFilter,%20java.lang.Object) "addNotificationListener"), [removeNotificationListener](https://docs.oracle.com/javaee/7/api/javax/management/NotificationBroadcasterSupport.html#removeNotificationListener(javax.management.NotificationListener,%20javax.management.NotificationFilter,%20java.lang.Object) "removeNotificationListener"), [removeNotificationListener](https://docs.oracle.com/javaee/7/api/javax/management/NotificationBroadcasterSupport.html#removeNotificationListener(javax.management.NotificationListener) "removeNotificationListener"), [wait](https://docs.oracle.com/javaee/7/api/javax/management/NotificationBroadcasterSupport.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javaee/7/api/javax/management/NotificationBroadcasterSupport.html#wait() "wait"), [wait](https://docs.oracle.com/javaee/7/api/javax/management/NotificationBroadcasterSupport.html#wait(long) "wait"), [equals](https://docs.oracle.com/javaee/7/api/javax/management/NotificationBroadcasterSupport.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javaee/7/api/javax/management/NotificationBroadcasterSupport.html#toString() "toString"), [hashCode](https://docs.oracle.com/javaee/7/api/javax/management/NotificationBroadcasterSupport.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javaee/7/api/javax/management/NotificationBroadcasterSupport.html#getClass() "getClass"), [notify](https://docs.oracle.com/javaee/7/api/javax/management/NotificationBroadcasterSupport.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javaee/7/api/javax/management/NotificationBroadcasterSupport.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getEvent() Event type getter Returns: - returns event type string thrown by this emitter ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getMessage() Event message getter Returns: - message that is associated with event. ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public long send([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") data) Called to broadcast message on MBeanServer event bus. Internally, it calls NotificationBroadCasterSupport.sendNotification() method to dispatch the event. Parameters: `data` - - a data object sent as part of the event parameter. Returns: a sequence number associated with the emitted event. ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void setEvent([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") event) Event type setter Parameters: `event` - - event type set for this emitter. ### public void setMessage([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") message) Event message setter. Parameters: `message` - - message that is associated with event emitted. groovy [Groovy] Class JmxTimerFactory [Groovy] Class JmxTimerFactory ============================== * groovy.jmx.builder.JmxTimerFactory ``` class JmxTimerFactory extends [AbstractFactory](../../util/abstractfactory "AbstractFactory") ``` The JmxTimerFactory class generates a timer() node for JmxBuilder. This node crates a standard JMX Timer object that can be used to provide timing signals to registered JMX listeners. Syntax: ``` timer( name:"object name"\|ObjectName(), event:"...", message:"...", data:dataValue startDate:"now"\|dateValue period:"99d"\|"99h"\|"99m"\|"99s"\|99 occurences:long ) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[JmxTimerFactory](#JmxTimerFactory())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `boolean` \| `[isLeaf](#isLeaf())()` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") nodeName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") nodeParam, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") nodeAttribs)` \| \| \| `boolean` \| `[onHandleNodeAttributes](#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") nodeAttribs)` \| \| \| `void` \| `[onNodeCompleted](#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parentNode, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") thisNode)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractFactory](../../util/abstractfactory "AbstractFactory")` \| `[setParent](../../util/abstractfactory#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setParent"), [isLeaf](../../util/abstractfactory#isLeaf() "isLeaf"), [onNodeChildren](../../util/abstractfactory#onNodeChildren(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20groovy.lang.Closure) "onNodeChildren"), [setChild](../../util/abstractfactory#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setChild"), [onNodeCompleted](../../util/abstractfactory#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "onNodeCompleted"), [onFactoryRegistration](../../util/abstractfactory#onFactoryRegistration(groovy.util.FactoryBuilderSupport,%20java.lang.String,%20java.lang.String) "onFactoryRegistration"), [isHandlesNodeChildren](../../util/abstractfactory#isHandlesNodeChildren() "isHandlesNodeChildren"), [onHandleNodeAttributes](../../util/abstractfactory#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map) "onHandleNodeAttributes"), [wait](../../util/abstractfactory#wait(long,%20int) "wait"), [wait](../../util/abstractfactory#wait() "wait"), [wait](../../util/abstractfactory#wait(long) "wait"), [equals](../../util/abstractfactory#equals(java.lang.Object) "equals"), [toString](../../util/abstractfactory#toString() "toString"), [hashCode](../../util/abstractfactory#hashCode() "hashCode"), [getClass](../../util/abstractfactory#getClass() "getClass"), [notify](../../util/abstractfactory#notify() "notify"), [notifyAll](../../util/abstractfactory#notifyAll() "notifyAll"), [newInstance](../../util/abstractfactory#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map) "newInstance")` \| Constructor Detail ------------------ ### JmxTimerFactory() Method Detail ------------- ### boolean isLeaf() ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") nodeName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") nodeParam, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") nodeAttribs) ### boolean onHandleNodeAttributes([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") nodeAttribs) ### void onNodeCompleted([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parentNode, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") thisNode) groovy [Groovy] Class JmxBuilderTools [Groovy] Class JmxBuilderTools ============================== * groovy.jmx.builder.JmxBuilderTools ``` class JmxBuilderTools extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` This is a utility class used as a helper for JmxBuilder. Properties Summary ------------------ Properties \| Type \| Name and description \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[ATTRIB\_KEY\_DEFAULT](#ATTRIB_KEY_DEFAULT)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[ATTRIB\_KEY\_DESC](#ATTRIB_KEY_DESC)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[ATTRIB\_KEY\_DESCRIPTION](#ATTRIB_KEY_DESCRIPTION)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[ATTRIB\_KEY\_TYPE](#ATTRIB_KEY_TYPE)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DEFAULT\_DOMAIN](#DEFAULT_DOMAIN)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DEFAULT\_NAME\_TYPE](#DEFAULT_NAME_TYPE)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DESC\_KEY](#DESC_KEY)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DESC\_KEY\_DISPLAY\_NAME](#DESC_KEY_DISPLAY_NAME)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DESC\_KEY\_EVENT\_MESSAGE](#DESC_KEY_EVENT_MESSAGE)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DESC\_KEY\_EVENT\_NAME](#DESC_KEY_EVENT_NAME)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DESC\_KEY\_EVENT\_SOURCE](#DESC_KEY_EVENT_SOURCE)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DESC\_KEY\_EVENT\_TYPE](#DESC_KEY_EVENT_TYPE)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DESC\_KEY\_GETMETHOD](#DESC_KEY_GETMETHOD)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DESC\_KEY\_JMX\_NAME](#DESC_KEY_JMX_NAME)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DESC\_KEY\_MBEAN\_ATTRIBS](#DESC_KEY_MBEAN_ATTRIBS)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DESC\_KEY\_MBEAN\_CTORS](#DESC_KEY_MBEAN_CTORS)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DESC\_KEY\_MBEAN\_NOTES](#DESC_KEY_MBEAN_NOTES)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DESC\_KEY\_MBEAN\_OPS](#DESC_KEY_MBEAN_OPS)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DESC\_KEY\_MBEAN\_RESOURCE](#DESC_KEY_MBEAN_RESOURCE)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DESC\_KEY\_MBEAN\_RESOURCE\_TYPE](#DESC_KEY_MBEAN_RESOURCE_TYPE)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DESC\_KEY\_NAME](#DESC_KEY_NAME)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DESC\_KEY\_READABLE](#DESC_KEY_READABLE)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DESC\_KEY\_ROLE](#DESC_KEY_ROLE)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DESC\_KEY\_SETMETHOD](#DESC_KEY_SETMETHOD)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DESC\_KEY\_SIGNATURE](#DESC_KEY_SIGNATURE)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DESC\_KEY\_TYPE](#DESC_KEY_TYPE)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DESC\_KEY\_WRITABLE](#DESC_KEY_WRITABLE)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DESC\_VAL\_TYPE\_ATTRIB](#DESC_VAL_TYPE_ATTRIB)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DESC\_VAL\_TYPE\_CTOR](#DESC_VAL_TYPE_CTOR)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DESC\_VAL\_TYPE\_GETTER](#DESC_VAL_TYPE_GETTER)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DESC\_VAL\_TYPE\_MBEAN](#DESC_VAL_TYPE_MBEAN)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DESC\_VAL\_TYPE\_NOTIFICATION](#DESC_VAL_TYPE_NOTIFICATION)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DESC\_VAL\_TYPE\_OP](#DESC_VAL_TYPE_OP)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DESC\_VAL\_TYPE\_SETTER](#DESC_VAL_TYPE_SETTER)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[EVENT\_KEY\_CALLBACK](#EVENT_KEY_CALLBACK)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[EVENT\_KEY\_CALLBACK\_RESULT](#EVENT_KEY_CALLBACK_RESULT)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[EVENT\_KEY\_CONTEXTS](#EVENT_KEY_CONTEXTS)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[EVENT\_KEY\_ISATTRIB](#EVENT_KEY_ISATTRIB)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[EVENT\_KEY\_MESSAGE](#EVENT_KEY_MESSAGE)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[EVENT\_KEY\_METHOD](#EVENT_KEY_METHOD)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[EVENT\_KEY\_METHOD\_RESULT](#EVENT_KEY_METHOD_RESULT)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[EVENT\_KEY\_NAME](#EVENT_KEY_NAME)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[EVENT\_KEY\_NODE\_TYPE](#EVENT_KEY_NODE_TYPE)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[EVENT\_KEY\_TARGETS](#EVENT_KEY_TARGETS)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[EVENT\_KEY\_TYPE](#EVENT_KEY_TYPE)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[EVENT\_VAL\_NODETYPE\_BROADCASTER](#EVENT_VAL_NODETYPE_BROADCASTER)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[EVENT\_VAL\_NODETYPE\_LISTENER](#EVENT_VAL_NODETYPE_LISTENER)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[JMX\_KEY](#JMX_KEY)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[NODE\_NAME\_ATTRIBS](#NODE_NAME_ATTRIBS)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[NODE\_NAME\_ATTRIBUTES](#NODE_NAME_ATTRIBUTES)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[NODE\_NAME\_CONSTRUCTORS](#NODE_NAME_CONSTRUCTORS)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[NODE\_NAME\_CTORS](#NODE_NAME_CTORS)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[NODE\_NAME\_OPERATIONS](#NODE_NAME_OPERATIONS)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[NODE\_NAME\_OPS](#NODE_NAME_OPS)` \| \| `static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")` \| `[PRIMITIVE\_TYPES](#PRIMITIVE_TYPES)` \| \| `static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")` \| `[TYPE\_MAP](#TYPE_MAP)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[JmxBuilderTools](#JmxBuilderTools())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[capitalize](#capitalize(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") value)`Capitalize the string passed. \| \| \| `static [ObjectName](https://docs.oracle.com/javaee/7/api/javax/management/ObjectName.html "ObjectName")` \| `[getDefaultObjectName](#getDefaultObjectName(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") obj)`Builds a default ObjectName() instance for a given backing POJO/POGO \| \| \| `static [MBeanServerConnection](https://docs.oracle.com/javaee/7/api/javax/management/MBeanServerConnection.html "MBeanServerConnection")` \| `[getMBeanServer](#getMBeanServer())()`Returns an MBeanServerConnection instance. \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getNormalizedType](#getNormalizedType(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") type)`Returns the proper type's class name when a short version is provided (i.e. \| \| \| `static [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")[]` \| `[getSignatureFromParamInfo](#getSignatureFromParamInfo(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") params)`Returns method signature (as Class[]) given the meta map that describes the method. \| \| \| `static boolean` \| `[isClassMBean](#isClassMBean(java.lang.Class))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") cls)`Tests whether the provided class implements MBean. \| \| \| `static [GroovyMBean](../groovymbean)` \| `[registerMBeanFromMap](#registerMBeanFromMap(java.lang.String,%20java.util.Map))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") regPolicy, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") metaMap)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[uncapitalize](#uncapitalize(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") value)`Uncapitalizes a string. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Property Detail --------------- ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") ATTRIB\_KEY\_DEFAULT ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") ATTRIB\_KEY\_DESC ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") ATTRIB\_KEY\_DESCRIPTION ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") ATTRIB\_KEY\_TYPE ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DEFAULT\_DOMAIN ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DEFAULT\_NAME\_TYPE ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DESC\_KEY ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DESC\_KEY\_DISPLAY\_NAME ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DESC\_KEY\_EVENT\_MESSAGE ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DESC\_KEY\_EVENT\_NAME ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DESC\_KEY\_EVENT\_SOURCE ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DESC\_KEY\_EVENT\_TYPE ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DESC\_KEY\_GETMETHOD ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DESC\_KEY\_JMX\_NAME ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DESC\_KEY\_MBEAN\_ATTRIBS ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DESC\_KEY\_MBEAN\_CTORS ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DESC\_KEY\_MBEAN\_NOTES ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DESC\_KEY\_MBEAN\_OPS ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DESC\_KEY\_MBEAN\_RESOURCE ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DESC\_KEY\_MBEAN\_RESOURCE\_TYPE ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DESC\_KEY\_NAME ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DESC\_KEY\_READABLE ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DESC\_KEY\_ROLE ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DESC\_KEY\_SETMETHOD ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DESC\_KEY\_SIGNATURE ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DESC\_KEY\_TYPE ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DESC\_KEY\_WRITABLE ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DESC\_VAL\_TYPE\_ATTRIB ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DESC\_VAL\_TYPE\_CTOR ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DESC\_VAL\_TYPE\_GETTER ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DESC\_VAL\_TYPE\_MBEAN ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DESC\_VAL\_TYPE\_NOTIFICATION ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DESC\_VAL\_TYPE\_OP ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DESC\_VAL\_TYPE\_SETTER ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") EVENT\_KEY\_CALLBACK ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") EVENT\_KEY\_CALLBACK\_RESULT ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") EVENT\_KEY\_CONTEXTS ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") EVENT\_KEY\_ISATTRIB ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") EVENT\_KEY\_MESSAGE ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") EVENT\_KEY\_METHOD ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") EVENT\_KEY\_METHOD\_RESULT ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") EVENT\_KEY\_NAME ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") EVENT\_KEY\_NODE\_TYPE ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") EVENT\_KEY\_TARGETS ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") EVENT\_KEY\_TYPE ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") EVENT\_VAL\_NODETYPE\_BROADCASTER ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") EVENT\_VAL\_NODETYPE\_LISTENER ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") JMX\_KEY ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") NODE\_NAME\_ATTRIBS ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") NODE\_NAME\_ATTRIBUTES ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") NODE\_NAME\_CONSTRUCTORS ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") NODE\_NAME\_CTORS ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") NODE\_NAME\_OPERATIONS ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") NODE\_NAME\_OPS ### static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") PRIMITIVE\_TYPES ### static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") TYPE\_MAP Constructor Detail ------------------ ### JmxBuilderTools() Method Detail ------------- ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") capitalize([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") value) Capitalize the string passed. Parameters: `value` - - string to capitalize. Returns: - a capitalized string. ### static [ObjectName](https://docs.oracle.com/javaee/7/api/javax/management/ObjectName.html "ObjectName") getDefaultObjectName([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") obj) Builds a default ObjectName() instance for a given backing POJO/POGO Parameters: `obj` - - the backing pojo/pogo Returns: the generated ObjectName() instance. ### static [MBeanServerConnection](https://docs.oracle.com/javaee/7/api/javax/management/MBeanServerConnection.html "MBeanServerConnection") getMBeanServer() Returns an MBeanServerConnection instance. It searches for declared MBeanServers from the MBeanServerFactory. If none is found, the default Platform MBeanServer is returned. ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getNormalizedType([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") type) Returns the proper type's class name when a short version is provided (i.e. String returns java.lang.String) Parameters: `type` - - the type name to normalize Returns: the normalized type name. ### static [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")[] getSignatureFromParamInfo([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") params) Returns method signature (as Class[]) given the meta map that describes the method. Parameters: `params` - - the map with parameter info. Returns: Class[] that represent the method signature. ### static boolean isClassMBean([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") cls) Tests whether the provided class implements MBean. It uses the following runes ``` if( DynamicMBean.class.isAssignable(cls) \|\| cls.getName().endsWith("MBean") \|\| cls.getName().endsWith("MXBean") ) then class is MBean ``` Parameters: `cls` - - class to test Returns: true = if class implements DynamicMBean or interface name that ends in MBean or MXBean. ### static [GroovyMBean](../groovymbean) registerMBeanFromMap([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") regPolicy, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") metaMap) ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uncapitalize([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") value) Uncapitalizes a string. Parameters: `value` - - string to uncap. Returns: uncap'ed string.	programming_docs
groovy [Groovy] Class JmxListenerFactory [Groovy] Class JmxListenerFactory ================================= * groovy.jmx.builder.JmxListenerFactory ``` class JmxListenerFactory extends [AbstractFactory](../../util/abstractfactory "AbstractFactory") ``` This factory class is used to create a listener() node for JmxBuilder. Listener nodes are used to create a generic event listener (that is automatically registered with the MBean) that can handle any event broadcasted on the MBeanServer's event bus. Syntax supported: ``` JmxBuilder.listener(event:"event type", from:"Object Name"\|ObjectName(), call:{event-> // event handling code here. }) ``` See Also: [JmxEventListener](jmxeventlistener "JmxEventListener") Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[JmxListenerFactory](#JmxListenerFactory())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `boolean` \| `[isLeaf](#isLeaf())()` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") nodeName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") nodeParam, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") nodeAttribs)` \| \| \| `boolean` \| `[onHandleNodeAttributes](#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") nodeAttribs)` \| \| \| `void` \| `[onNodeCompleted](#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parentNode, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") thisNode)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractFactory](../../util/abstractfactory "AbstractFactory")` \| `[setParent](../../util/abstractfactory#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setParent"), [isLeaf](../../util/abstractfactory#isLeaf() "isLeaf"), [onNodeChildren](../../util/abstractfactory#onNodeChildren(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20groovy.lang.Closure) "onNodeChildren"), [setChild](../../util/abstractfactory#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setChild"), [onNodeCompleted](../../util/abstractfactory#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "onNodeCompleted"), [onFactoryRegistration](../../util/abstractfactory#onFactoryRegistration(groovy.util.FactoryBuilderSupport,%20java.lang.String,%20java.lang.String) "onFactoryRegistration"), [isHandlesNodeChildren](../../util/abstractfactory#isHandlesNodeChildren() "isHandlesNodeChildren"), [onHandleNodeAttributes](../../util/abstractfactory#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map) "onHandleNodeAttributes"), [wait](../../util/abstractfactory#wait(long,%20int) "wait"), [wait](../../util/abstractfactory#wait() "wait"), [wait](../../util/abstractfactory#wait(long) "wait"), [equals](../../util/abstractfactory#equals(java.lang.Object) "equals"), [toString](../../util/abstractfactory#toString() "toString"), [hashCode](../../util/abstractfactory#hashCode() "hashCode"), [getClass](../../util/abstractfactory#getClass() "getClass"), [notify](../../util/abstractfactory#notify() "notify"), [notifyAll](../../util/abstractfactory#notifyAll() "notifyAll"), [newInstance](../../util/abstractfactory#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map) "newInstance")` \| Constructor Detail ------------------ ### JmxListenerFactory() Method Detail ------------- ### boolean isLeaf() ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") nodeName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") nodeParam, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") nodeAttribs) ### boolean onHandleNodeAttributes([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") nodeAttribs) ### void onNodeCompleted([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parentNode, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") thisNode) groovy [Groovy] Class JmxAttributeInfoManager [Groovy] Class JmxAttributeInfoManager ====================================== * groovy.jmx.builder.JmxAttributeInfoManager ``` class JmxAttributeInfoManager extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` This class is responsible for assembling JMX Attribute Info from the meta map. It cycles through the meta map from the Node and generate JMX Info objects used to expose information in the MBeanServer. See Also: [JmxMetaMapBuilder](jmxmetamapbuilder "JmxMetaMapBuilder") Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[JmxAttributeInfoManager](#JmxAttributeInfoManager())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `static [ModelMBeanAttributeInfo](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/ModelMBeanAttributeInfo.html "ModelMBeanAttributeInfo")` \| `[getAttributeInfoFromMap](#getAttributeInfoFromMap(java.util.Map))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") map)`This method builds a single ModelMBeanAttribute info from a given meta data map object. \| \| \| `static [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<ModelMBeanAttributeInfo>` \| `[getAttributeInfosFromMap](#getAttributeInfosFromMap(java.util.Map))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") metaMap)`Generates a list of ModelMBeanAttributeInfo from a list meta data Maps. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### JmxAttributeInfoManager() Method Detail ------------- ### static [ModelMBeanAttributeInfo](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/ModelMBeanAttributeInfo.html "ModelMBeanAttributeInfo") getAttributeInfoFromMap([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") map) This method builds a single ModelMBeanAttribute info from a given meta data map object. Parameters: `map` - the map object containing the meta data Returns: the generated ModelMBeanAttribute Info object. ### static [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<ModelMBeanAttributeInfo> getAttributeInfosFromMap([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") metaMap) Generates a list of ModelMBeanAttributeInfo from a list meta data Maps. Parameters: `metaMap` - list of meta data maps Returns: ModelMBeanAttributeInfo groovy [Groovy] Class JmxBeanInfoManager [Groovy] Class JmxBeanInfoManager ================================= * groovy.jmx.builder.JmxBeanInfoManager ``` class JmxBeanInfoManager extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` The JmxBeanInfoManager creates fully-described model mbean info object using the underlying meta map. The MBeanInfo object is used to provide description about the actual exported MBean instance. Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[JmxBeanInfoManager](#JmxBeanInfoManager())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `static [ObjectName](https://docs.oracle.com/javaee/7/api/javax/management/ObjectName.html "ObjectName")` \| `[buildDefaultObjectName](#buildDefaultObjectName(java.lang.String,%20java.lang.String,%20java.lang.Object))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") defaultDomain, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") defaultType, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object)`Builds a default JMX ObjectName instance using meta data from object. \| \| \| `static [ModelMBeanInfo](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/ModelMBeanInfo.html "ModelMBeanInfo")` \| `[getModelMBeanInfoFromMap](#getModelMBeanInfoFromMap(java.util.Map))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") map)`Returns a fully-realized ModelMBeanInfo object from info gathered from the associated meta map. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### JmxBeanInfoManager() Method Detail ------------- ### static [ObjectName](https://docs.oracle.com/javaee/7/api/javax/management/ObjectName.html "ObjectName") buildDefaultObjectName([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") defaultDomain, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") defaultType, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object) Builds a default JMX ObjectName instance using meta data from object. Parameters: `object` - used for name Returns: an instance of ObjectName ### static [ModelMBeanInfo](https://docs.oracle.com/javaee/7/api/javax/management/modelmbean/ModelMBeanInfo.html "ModelMBeanInfo") getModelMBeanInfoFromMap([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") map) Returns a fully-realized ModelMBeanInfo object from info gathered from the associated meta map. Parameters: `map` - map of object Returns: ModelMBeanInfo built from map groovy [Groovy] Class JmxEmitterFactory [Groovy] Class JmxEmitterFactory ================================ * groovy.jmx.builder.JmxEmitterFactory ``` class JmxEmitterFactory extends [AbstractFactory](../../util/abstractfactory "AbstractFactory") ``` This class is the factory for the emitter node. This node facilitates the declaration of a JMX event emitter. The emitter is used to broadcast arbitrary event on the MBeanServer's event bus. Registered listeners are able to consume event once sent. Supported syntax: ``` def jmx = JmxBuilder() jmx.emitter(name:"Object name"\|ObjectName(), event:"event type") ... jmx.emitter.send(object) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[JmxEmitterFactory](#JmxEmitterFactory())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `boolean` \| `[isLeaf](#isLeaf())()` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") nodeName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") nodeParam, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") nodeAttribs)` \| \| \| `boolean` \| `[onHandleNodeAttributes](#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") nodeAttribs)` \| \| \| `void` \| `[onNodeCompleted](#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parentNode, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") thisNode)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractFactory](../../util/abstractfactory "AbstractFactory")` \| `[setParent](../../util/abstractfactory#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setParent"), [isLeaf](../../util/abstractfactory#isLeaf() "isLeaf"), [onNodeChildren](../../util/abstractfactory#onNodeChildren(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20groovy.lang.Closure) "onNodeChildren"), [setChild](../../util/abstractfactory#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setChild"), [onNodeCompleted](../../util/abstractfactory#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "onNodeCompleted"), [onFactoryRegistration](../../util/abstractfactory#onFactoryRegistration(groovy.util.FactoryBuilderSupport,%20java.lang.String,%20java.lang.String) "onFactoryRegistration"), [isHandlesNodeChildren](../../util/abstractfactory#isHandlesNodeChildren() "isHandlesNodeChildren"), [onHandleNodeAttributes](../../util/abstractfactory#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map) "onHandleNodeAttributes"), [wait](../../util/abstractfactory#wait(long,%20int) "wait"), [wait](../../util/abstractfactory#wait() "wait"), [wait](../../util/abstractfactory#wait(long) "wait"), [equals](../../util/abstractfactory#equals(java.lang.Object) "equals"), [toString](../../util/abstractfactory#toString() "toString"), [hashCode](../../util/abstractfactory#hashCode() "hashCode"), [getClass](../../util/abstractfactory#getClass() "getClass"), [notify](../../util/abstractfactory#notify() "notify"), [notifyAll](../../util/abstractfactory#notifyAll() "notifyAll"), [newInstance](../../util/abstractfactory#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map) "newInstance")` \| Constructor Detail ------------------ ### JmxEmitterFactory() Method Detail ------------- ### boolean isLeaf() ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") nodeName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") nodeParam, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") nodeAttribs) ### boolean onHandleNodeAttributes([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") nodeAttribs) ### void onNodeCompleted([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parentNode, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") thisNode) groovy [Groovy] Class JmxMetaMapBuilder [Groovy] Class JmxMetaMapBuilder ================================ * groovy.jmx.builder.JmxMetaMapBuilder ``` class JmxMetaMapBuilder extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` The JmxMetaMapBuilder class is used to collect meta data passed in JmxBuilder nodes. Once collected, the data is then normalized to be represented uniformly regardless of the resource where it was obtained. Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[JmxMetaMapBuilder](#JmxMetaMapBuilder())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")` \| `[buildAttributeMapFrom](#buildAttributeMapFrom(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object)`Builds attribute meta map with default information from an instance of an object. \| \| \| `static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")` \| `[buildAttributeMapFrom](#buildAttributeMapFrom(java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") descCollection)`Sanitizes and builds an attribute meta map from a descriptor collection. \| \| \| `static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")` \| `[buildConstructorMapFrom](#buildConstructorMapFrom(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object)`Returns a meta map of constructors from given object. \| \| \| `static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")` \| `[buildConstructorMapFrom](#buildConstructorMapFrom(java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") descCollection)`Builds a fully normalized constructor meta map. \| \| \| `static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[buildListenerMapFrom](#buildListenerMapFrom(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") descCollection)`Creates a fully-normalized meta map for a given collection of listeners. \| \| \| `static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")` \| `[buildObjectMapFrom](#buildObjectMapFrom(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object)`Builds a complete meta map graph for the specified object using default values. \| \| \| `static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")` \| `[buildObjectMapFrom](#buildObjectMapFrom(java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") descriptor)`Builds a complete meta map graph for a given target and descriptor. \| \| \| `static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")` \| `[buildOperationMapFrom](#buildOperationMapFrom(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object)`Returns a meta map of operations from given object. \| \| \| `static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")` \| `[buildOperationMapFrom](#buildOperationMapFrom(java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") descCollection)` \| \| \| `static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")` \| `[buildParameterMapFrom](#buildParameterMapFrom(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") method)`Builds a normalized parameter meta map for all params on provided method. \| \| \| `static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")` \| `[buildParameterMapFrom](#buildParameterMapFrom(java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") method, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") descCollection)`Builds a fully normalized parameter meta map for the method and the given meta map. \| \| \| `static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")` \| `[createListenerMap](#createListenerMap(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") descriptor)`Builds normalized meta map of the provided listener descriptor. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### JmxMetaMapBuilder() Method Detail ------------- ### static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") buildAttributeMapFrom([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object) Builds attribute meta map with default information from an instance of an object. Parameters: `the` - object from which attribute info will be retrieved Returns: the meta map for the attribute ### static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") buildAttributeMapFrom([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") descCollection) Sanitizes and builds an attribute meta map from a descriptor collection. The collection can either be a map of the form [attribName:[descriptor...],...] or [attribName1,...attribNameN]. The code guests sensible defaults when values are not provided Parameters: `the` - object about which meta data is collected `descriptor` - collection: either a map or a list Returns: a Map of meta information about the object. ### static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") buildConstructorMapFrom([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object) Returns a meta map of constructors from given object. Parameters: `object` - to profile Returns: The meta map generated. ### static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") buildConstructorMapFrom([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") descCollection) Builds a fully normalized constructor meta map. Parameters: `the` - object where constructor is defined. `the` - meta map that will be normalized Returns: a normalized meta map for the constructor ### static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") buildListenerMapFrom([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") descCollection) Creates a fully-normalized meta map for a given collection of listeners. Parameters: `-` - collection of descriptors to normalize See Also: [JmxMetaMapBuilder.createListenerMap](jmxmetamapbuilder#createListenerMap(java.lang.Object) "JmxMetaMapBuilder.createListenerMap") ### static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") buildObjectMapFrom([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object) Builds a complete meta map graph for the specified object using default values. All generated attributes are set to read-only. Parameters: `object` - used to build meta data graph Returns: fully-realized meta map of the object See Also: [buildAttributeMapFrom(Object)](#buildAttributeMapFrom(java.lang.Object)) [buildConstructorMapFrom(Object)](#buildConstructorMapFrom(java.lang.Object)) [buildOperationMapFrom(Object)](#buildOperationMapFrom(java.lang.Object)) ### static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") buildObjectMapFrom([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") descriptor) Builds a complete meta map graph for a given target and descriptor. Parameters: `object` - used to build meta data graph `descriptor` - a full descriptor map describing object attributes and ops. Returns: fully-realized meta map of the object See Also: [buildAttributeMapFrom(Object, Map)](#buildAttributeMapFrom(java.lang.Object,%20java.util.Map)) [buildConstructorMapFrom(Object, Map)](#buildConstructorMapFrom(java.lang.Object,%20java.util.Map)) [buildOperationMapFrom(Object, Map)](#buildOperationMapFrom(java.lang.Object,%20java.util.Map)) ### static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") buildOperationMapFrom([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object) Returns a meta map of operations from given object. Parameters: `object` - to profile Returns: The meta map generated. ### static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") buildOperationMapFrom([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") descCollection) ### static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") buildParameterMapFrom([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") method) Builds a normalized parameter meta map for all params on provided method. Parameters: `the` - method with parameters to normalized Returns: the normalized map ### static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") buildParameterMapFrom([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") method, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") descCollection) Builds a fully normalized parameter meta map for the method and the given meta map. Parameters: `the` - method from which to extract normalized info. `a` - given meta map which will be normalized Returns: the normalized map ### static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") createListenerMap([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") descriptor) Builds normalized meta map of the provided listener descriptor. Parameters: `descriptor` - - descriptive data collected from JmxBuilder listener nodes. Returns: - fully normalized meta map of listener data.	programming_docs
groovy [Groovy] Class JmxClientConnectorFactory [Groovy] Class JmxClientConnectorFactory ======================================== * groovy.jmx.builder.JmxClientConnectorFactory ``` class JmxClientConnectorFactory extends [AbstractFactory](../../util/abstractfactory "AbstractFactory") ``` This is the factory for node JmxBuilder.connectorClient. A call to this node returns an instance of the JMXConnector interface. ``` JmxBuilder.clientConnector ( protocol:"rmi", host:"...", port:1099, url:"...", ) ``` See Also: [JMXConnector](http://java.sun.com/j2se/1.5.0/docs/api/javax/management/remote/JMXConnector.html) Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[JmxClientConnectorFactory](#JmxClientConnectorFactory())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") nodeName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") nodeArgs, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") nodeAttribs)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractFactory](../../util/abstractfactory "AbstractFactory")` \| `[setParent](../../util/abstractfactory#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setParent"), [isLeaf](../../util/abstractfactory#isLeaf() "isLeaf"), [onNodeChildren](../../util/abstractfactory#onNodeChildren(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20groovy.lang.Closure) "onNodeChildren"), [setChild](../../util/abstractfactory#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setChild"), [onNodeCompleted](../../util/abstractfactory#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "onNodeCompleted"), [onFactoryRegistration](../../util/abstractfactory#onFactoryRegistration(groovy.util.FactoryBuilderSupport,%20java.lang.String,%20java.lang.String) "onFactoryRegistration"), [isHandlesNodeChildren](../../util/abstractfactory#isHandlesNodeChildren() "isHandlesNodeChildren"), [onHandleNodeAttributes](../../util/abstractfactory#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map) "onHandleNodeAttributes"), [wait](../../util/abstractfactory#wait(long,%20int) "wait"), [wait](../../util/abstractfactory#wait() "wait"), [wait](../../util/abstractfactory#wait(long) "wait"), [equals](../../util/abstractfactory#equals(java.lang.Object) "equals"), [toString](../../util/abstractfactory#toString() "toString"), [hashCode](../../util/abstractfactory#hashCode() "hashCode"), [getClass](../../util/abstractfactory#getClass() "getClass"), [notify](../../util/abstractfactory#notify() "notify"), [notifyAll](../../util/abstractfactory#notifyAll() "notifyAll"), [newInstance](../../util/abstractfactory#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map) "newInstance")` \| Constructor Detail ------------------ ### JmxClientConnectorFactory() Method Detail ------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") nodeName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") nodeArgs, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") nodeAttribs) groovy [Java] Annotation Type Contracted [Java] Annotation Type Contracted ================================= * groovy.contracts.Contracted ``` @[Target](https://docs.groovy-lang.org/docs/ant/api/org/apache/tools/ant/Target.html "Target")({ElementType.PACKAGE, ElementType.TYPE}) @[Retention](https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html "Retention")(RetentionPolicy.RUNTIME) public @interface Contracted ``` Package-level and class-level annotation indicating that the package is enabled for class-invariants, pre- and post-conditions. For example: ``` @Contracted package my.package import groovy.contracts.* ``` Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| groovy [Java] Annotation Type Invariant [Java] Annotation Type Invariant ================================ * groovy.contracts.Invariant ``` @[Retention](https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html "Retention")(RetentionPolicy.RUNTIME) @[Target](https://docs.groovy-lang.org/docs/ant/api/org/apache/tools/ant/Target.html "Target")(ElementType.TYPE) @[Incubating](../../org/apache/groovy/lang/annotation/incubating "Incubating") @[ClassInvariant](../../org/apache/groovy/contracts/annotations/meta/classinvariant "ClassInvariant") @[AnnotationProcessorImplementation](../../org/apache/groovy/contracts/annotations/meta/annotationprocessorimplementation "AnnotationProcessorImplementation")(ClassInvariantAnnotationProcessor.class) public @interface Invariant ``` Represents a class-invariant. The class-invariant defines assertions holding during the entire objects life-time. Class-invariants are verified at runtime at the following pointcuts: * after a constructor call * before a method call * after a method call Whenever a class has a parent which itself specifies a class-invariant, that class-invariant expression is combined with the actual class's invariant (by using a logical AND). Element Summary --------------- Required Element Summary \| Type \| Name and Description \| \| `[Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")` \| `[value](#value)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Element Detail -------------- ### public [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") value groovy [Java] Annotation Type Ensures [Java] Annotation Type Ensures ============================== * groovy.contracts.Ensures ``` @[Retention](https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html "Retention")(RetentionPolicy.RUNTIME) @[Target](https://docs.groovy-lang.org/docs/ant/api/org/apache/tools/ant/Target.html "Target")({ElementType.CONSTRUCTOR, ElementType.METHOD}) @[Incubating](../../org/apache/groovy/lang/annotation/incubating "Incubating") @[Postcondition](../../org/apache/groovy/contracts/annotations/meta/postcondition "Postcondition") @[AnnotationProcessorImplementation](../../org/apache/groovy/contracts/annotations/meta/annotationprocessorimplementation "AnnotationProcessorImplementation")(EnsuresAnnotationProcessor.class) public @interface Ensures ``` Represents a method postcondition. A postcondition is a condition that is guaranteed to be fulfilled by suppliers. A method's postcondition is executed after a method call has finished. A successor's postcondition strengthens the postcondition of its parent class, e.g. if A.someMethod declares a postcondition and B.someMethod overrides the method the postconditions are combined with a boolean AND. Compared to pre-conditions, postcondition annotation closures are optionally called with two additional closure arguments: result and old. result is available if the corresponding method has a non-void return-type and holds the result of the method call. Be aware that modifying the internal state of a reference type can lead to side-effects. Groovy-contracts does not keep track of any sort of modifications, neither any conversion to immutability. old is available in every postcondition. It is a [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") which holds the values of value types and [Cloneable](https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html "Cloneable") types before the method has been executed. Examples: Accessing the result closure parameter: ``` @Ensures({ result -> result != argument1 }) def T someOperation(def argument1, def argument2) { ... } ``` Accessing the old closure parameter: ``` @Ensures({ old -> old.counter + 1 == counter }) def T someOperation(def argument1, def argument2) { ... } ``` Element Summary --------------- Required Element Summary \| Type \| Name and Description \| \| `[Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")` \| `[value](#value)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Element Detail -------------- ### public [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") value groovy [Java] Annotation Type Requires [Java] Annotation Type Requires =============================== * groovy.contracts.Requires ``` @[Retention](https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html "Retention")(RetentionPolicy.RUNTIME) @[Target](https://docs.groovy-lang.org/docs/ant/api/org/apache/tools/ant/Target.html "Target")({ElementType.CONSTRUCTOR, ElementType.METHOD}) @[Incubating](../../org/apache/groovy/lang/annotation/incubating "Incubating") @[Precondition](../../org/apache/groovy/contracts/annotations/meta/precondition "Precondition") @[AnnotationProcessorImplementation](../../org/apache/groovy/contracts/annotations/meta/annotationprocessorimplementation "AnnotationProcessorImplementation")(RequiresAnnotationProcessor.class) public @interface Requires ``` Represents a method precondition. A precondition is a condition that must be met by clients of this class. Whenever the precondition can be satisfied, it is guaranteed that the supplier will fulfil the method's postcondition. A method's precondition is executed as the first statement within a method call. A successor's precondition weakens the precondition of its parent class, e.g. if A.someMethod declares a precondition and B.someMethod overrides the method the preconditions are combined with a boolean OR. Example: ``` @Requires({ argument1 != argument2 && argument2 >= 0 }) void someOperation(def argument1, def argument2) { ... } ``` Element Summary --------------- Required Element Summary \| Type \| Name and Description \| \| `[Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")` \| `[value](#value)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Element Detail -------------- ### public [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") value groovy [Groovy] Class MockInterceptor [Groovy] Class MockInterceptor ============================== * groovy.mock.interceptor.MockInterceptor All Implemented Interfaces and Traits: [PropertyAccessInterceptor](../../lang/propertyaccessinterceptor "PropertyAccessInterceptor") ``` class MockInterceptor extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") implements [PropertyAccessInterceptor](../../lang/propertyaccessinterceptor "PropertyAccessInterceptor") ``` Intercepting calls to the collaborating object and notify the expectation object. Properties Summary ------------------ Properties \| Type \| Name and description \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[expectation](#expectation)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[MockInterceptor](#MockInterceptor())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[afterInvoke](#afterInvoke(java.lang.Object,%20java.lang.String,%20java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] arguments, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") result)` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[beforeGet](#beforeGet(java.lang.Object,%20java.lang.String))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") property)` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[beforeInvoke](#beforeInvoke(java.lang.Object,%20java.lang.String,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] arguments)` \| \| \| `void` \| `[beforeSet](#beforeSet(java.lang.Object,%20java.lang.String,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") property, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newValue)` \| \| \| `boolean` \| `[doInvoke](#doInvoke())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Property Detail --------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") expectation Constructor Detail ------------------ ### MockInterceptor() Method Detail ------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") afterInvoke([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] arguments, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") result) ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") beforeGet([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") property) ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") beforeInvoke([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] arguments) ### void beforeSet([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") property, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newValue) ### boolean doInvoke()	programming_docs
groovy [Groovy] Class LooseExpectation [Groovy] Class LooseExpectation =============================== * groovy.mock.interceptor.LooseExpectation ``` class LooseExpectation extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Expects demanded call cardinalities to match demanded ranges. The calls are allowed to be out of the recorded sequence. If a method is demanded multiple times, the ranges are filled by order of recording. See Also: [StrictExpectation](strictexpectation "StrictExpectation") Properties Summary ------------------ Properties \| Type \| Name and description \| \| `[List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")` \| `[fCalls](#fCalls)` \| \| `[Demand](demand)` \| `[fDemand](#fDemand)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[LooseExpectation](#LooseExpectation(groovy.mock.interceptor.Demand))([Demand](demand) demand)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `boolean` \| `[isEligible](#isEligible(java.lang.String,%20int))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, int i)` \| \| \| `[Closure](../../lang/closure)` \| `[match](#match(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name)`Match the requested method name against eligible demands. \| \| \| `void` \| `[verify](#verify())()`verify all calls are in expected range \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Property Detail --------------- ### [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") fCalls ### [Demand](demand) fDemand Constructor Detail ------------------ ### LooseExpectation([Demand](demand) demand) Method Detail ------------- ### boolean isEligible([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, int i) ### [Closure](../../lang/closure) match([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name) Match the requested method name against eligible demands. Fail early if no match possible. Return the demand's behavior closure on match. Also skips over names matching ignore filter, if any. ### void verify() verify all calls are in expected range groovy [Java] Class MockProxyMetaClass [Java] Class MockProxyMetaClass =============================== * groovy.mock.interceptor.MockProxyMetaClass ``` public class MockProxyMetaClass extends [ProxyMetaClass](../../lang/proxymetaclass) ``` Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `boolean` \| `[interceptConstruction](#interceptConstruction)` \| \| Inherited fields \| Fields inherited from class \| Fields \| \| `class [ProxyMetaClass](../../lang/proxymetaclass)` \| `[adaptee](../../lang/proxymetaclass#adaptee), [interceptor](../../lang/proxymetaclass#interceptor)` \| \| `class [MetaClassImpl](../../lang/metaclassimpl)` \| `[EMPTY\_ARGUMENTS](../../lang/metaclassimpl#EMPTY_ARGUMENTS), [INVOKE\_METHOD\_METHOD](../../lang/metaclassimpl#INVOKE_METHOD_METHOD), [METHOD\_MISSING](../../lang/metaclassimpl#METHOD_MISSING), [PROPERTY\_MISSING](../../lang/metaclassimpl#PROPERTY_MISSING), [STATIC\_METHOD\_MISSING](../../lang/metaclassimpl#STATIC_METHOD_MISSING), [STATIC\_PROPERTY\_MISSING](../../lang/metaclassimpl#STATIC_PROPERTY_MISSING), [getPropertyMethod](../../lang/metaclassimpl#getPropertyMethod), [invokeMethodMethod](../../lang/metaclassimpl#invokeMethodMethod), [isGroovyObject](../../lang/metaclassimpl#isGroovyObject), [isMap](../../lang/metaclassimpl#isMap), [metaMethodIndex](../../lang/metaclassimpl#metaMethodIndex), [registry](../../lang/metaclassimpl#registry), [setPropertyMethod](../../lang/metaclassimpl#setPropertyMethod), [theCachedClass](../../lang/metaclassimpl#theCachedClass), [theClass](../../lang/metaclassimpl#theClass)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[MockProxyMetaClass](#MockProxyMetaClass(groovy.lang.MetaClassRegistry,%20java.lang.Class,%20groovy.lang.MetaClass))([MetaClassRegistry](../../lang/metaclassregistry) registry, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") theClass, [MetaClass](../../lang/metaclass) adaptee)` Parameters: `adaptee` - the MetaClass to decorate with interceptability \| \| `[MockProxyMetaClass](#MockProxyMetaClass(groovy.lang.MetaClassRegistry,%20java.lang.Class,%20groovy.lang.MetaClass,%20boolean))([MetaClassRegistry](../../lang/metaclassregistry) registry, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") theClass, [MetaClass](../../lang/metaclass) adaptee, boolean interceptConstruction)` Parameters: `adaptee` - the MetaClass to decorate with interceptability \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getProperty](#getProperty(java.lang.Class,%20java.lang.Object,%20java.lang.String,%20boolean,%20boolean))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") aClass, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") property, boolean b, boolean b1)` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[invokeConstructor](#invokeConstructor(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] arguments)`Unlike general impl in superclass, ctors are not intercepted but relayed unless interceptConstruction is set. \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[invokeMethod](#invokeMethod(java.lang.Object,%20java.lang.String,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] arguments)` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[invokeMethod](#invokeMethod(java.lang.Class,%20java.lang.Object,%20java.lang.String,%20java.lang.Object,%20boolean,%20boolean))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") sender, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] arguments, boolean isCallToSuper, boolean fromInsideClass)` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[invokeStaticMethod](#invokeStaticMethod(java.lang.Object,%20java.lang.String,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] arguments)` \| \| \| `public static [MockProxyMetaClass](mockproxymetaclass)` \| `[make](#make(java.lang.Class))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") theClass)`convenience factory method for the most usual case. \| \| \| `public static [MockProxyMetaClass](mockproxymetaclass)` \| `[make](#make(java.lang.Class,%20boolean))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") theClass, boolean interceptConstruction)`convenience factory method allowing interceptConstruction to be set. \| \| \| `public void` \| `[setProperty](#setProperty(java.lang.Class,%20java.lang.Object,%20java.lang.String,%20java.lang.Object,%20boolean,%20boolean))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") aClass, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") property, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newValue, boolean b, boolean b1)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [ProxyMetaClass](../../lang/proxymetaclass)` \| `[getAdaptee](../../lang/proxymetaclass#getAdaptee()), [getInstance](../../lang/proxymetaclass#getInstance(java.lang.Class)), [getInterceptor](../../lang/proxymetaclass#getInterceptor()), [getProperty](../../lang/proxymetaclass#getProperty(java.lang.Class,%20java.lang.Object,%20java.lang.String,%20boolean,%20boolean)), [initialize](../../lang/proxymetaclass#initialize()), [invokeConstructor](../../lang/proxymetaclass#invokeConstructor(java.lang.Object)), [invokeMethod](../../lang/proxymetaclass#invokeMethod(java.lang.Object,%20java.lang.String,%20java.lang.Object)), [invokeMethod](../../lang/proxymetaclass#invokeMethod(java.lang.Class,%20java.lang.Object,%20java.lang.String,%20java.lang.Object,%20boolean,%20boolean)), [invokeStaticMethod](../../lang/proxymetaclass#invokeStaticMethod(java.lang.Object,%20java.lang.String,%20java.lang.Object)), [setAdaptee](../../lang/proxymetaclass#setAdaptee(groovy.lang.MetaClass)), [setInterceptor](../../lang/proxymetaclass#setInterceptor(groovy.lang.Interceptor)), [setProperty](../../lang/proxymetaclass#setProperty(java.lang.Class,%20java.lang.Object,%20java.lang.String,%20java.lang.Object,%20boolean,%20boolean)), [use](../../lang/proxymetaclass#use(groovy.lang.Closure)), [use](../../lang/proxymetaclass#use(groovy.lang.GroovyObject,%20groovy.lang.Closure))` \| \| `class [MetaClassImpl](../../lang/metaclassimpl)` \| `[getMetaMethod](../../lang/metaclassimpl#getMetaMethod(java.lang.String,%20java.lang.Object)), [getMetaProperty](../../lang/metaclassimpl#getMetaProperty(java.lang.String)), [getRegistry](../../lang/metaclassimpl#getRegistry()), [getStaticMetaMethod](../../lang/metaclassimpl#getStaticMetaMethod(java.lang.String,%20java.lang.Object)), [getSuperClasses](../../lang/metaclassimpl#getSuperClasses()), [getTheCachedClass](../../lang/metaclassimpl#getTheCachedClass()), [getTheClass](../../lang/metaclassimpl#getTheClass()), [hasProperty](../../lang/metaclassimpl#hasProperty(java.lang.Object,%20java.lang.String)), [isGroovyObject](../../lang/metaclassimpl#isGroovyObject()), [methodNameAction](../../lang/metaclassimpl#methodNameAction(Class,%20org.codehaus.groovy.runtime.metaclass.MetaMethodIndex.Entry)), [respondsTo](../../lang/metaclassimpl#respondsTo(java.lang.Object,%20java.lang.String,%20java.lang.Object)), [respondsTo](../../lang/metaclassimpl#respondsTo(java.lang.Object,%20java.lang.String)), [skipClass](../../lang/metaclassimpl#skipClass(Class))` \| Field Detail ------------ ### public final boolean interceptConstruction Constructor Detail ------------------ ### public MockProxyMetaClass([MetaClassRegistry](../../lang/metaclassregistry) registry, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") theClass, [MetaClass](../../lang/metaclass) adaptee) Parameters: `adaptee` - the MetaClass to decorate with interceptability ### public MockProxyMetaClass([MetaClassRegistry](../../lang/metaclassregistry) registry, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") theClass, [MetaClass](../../lang/metaclass) adaptee, boolean interceptConstruction) Parameters: `adaptee` - the MetaClass to decorate with interceptability Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getProperty([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") aClass, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") property, boolean b, boolean b1) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") invokeConstructor([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] arguments) Unlike general impl in superclass, ctors are not intercepted but relayed unless interceptConstruction is set. ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") invokeMethod([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] arguments) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") invokeMethod([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") sender, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] arguments, boolean isCallToSuper, boolean fromInsideClass) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") invokeStaticMethod([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] arguments) ### public static [MockProxyMetaClass](mockproxymetaclass) make([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") theClass) convenience factory method for the most usual case. ### public static [MockProxyMetaClass](mockproxymetaclass) make([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") theClass, boolean interceptConstruction) convenience factory method allowing interceptConstruction to be set. ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void setProperty([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") aClass, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") property, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newValue, boolean b, boolean b1) groovy [Groovy] Class Ignore [Groovy] Class Ignore ===================== * groovy.mock.interceptor.Ignore ``` class Ignore extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Helper object to support convenience "ignore.methodName" notation similar to demand notation. Can't be used with methods within `java.lang.Object`. Properties Summary ------------------ Properties \| Type \| Name and description \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[parent](#parent)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[Ignore](#Ignore())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[invokeMethod](#invokeMethod(java.lang.String,%20java.lang.Object))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Property Detail --------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent Constructor Detail ------------------ ### Ignore() Method Detail ------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") invokeMethod([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args) groovy [Groovy] Class MockFor [Groovy] Class MockFor ====================== * groovy.mock.interceptor.MockFor ``` class MockFor extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` MockFor supports (typically unit) testing of classes in isolation by allowing a strictly ordered expectation of the behavior of collaborators to be defined. A typical test scenario involves a class under test (CUT) and one or more collaborators. In such a scenario it is often desirable to just test the business logic of the CUT. One strategy for doing that is to replace the collaborator instances with simplified mock objects to help isolate out the logic in the CUT. MockFor allows such mocks to be created using meta-programming. The desired behavior of collaborators is defined as a behavior specification. The behavior is enforced and checked automatically. With MockFor, a mock's expectation is always sequence dependent and its use automatically ends with a verify(). Typical usage is as follows: ``` import groovy.mock.interceptor.MockFor class Person { String first, last } class Family { Person father, mother def nameOfMother() { "$mother.first $mother.last" } } def mock = new MockFor(Person) mock.demand.getFirst{ 'dummy' } mock.demand.getLast{ 'name' } mock.use { def mary = new Person(first:'Mary', last:'Smith') def f = new Family(mother:mary) assert f.nameOfMother() == 'dummy name' } ``` Here, `Family` is our class under test and `Person` is the collaborator. We are using normal Groovy property semantics here; hence the statement `mother.last` causes a call to `mother.getLast()` to occur. The following features are supported: * typical mock style of failing early * mocks instance and class/static methods * mocks property access using normal getters and setters * mocks final methods and final Collaborators * mocks Groovy and Java Collaborators (Caller must normally be Groovy but see `proxyDelegateInstance()`) * can mock all objects of a given class (or a single Groovy object) * mocks even if Collaborator cannot be injected into the Caller * mocks even if Collaborator is not accessible on the Caller (no getter) * demanded calls specified via recording calls on the Demand object (EasyMock style). * cardinality specified as Integers or Ranges, default is 1..1; 'optional' can be achieved with 0..1 * behavior specified via Closures, allowing static or calculated return values, throwing exceptions, asserting argument values, etc. (even tricky sequence constraints by sharing state in the testMethod scope between the behavior Closures) * matching parameter list specified via Closure's parameter list, supporting typed or untyped params, default params, and varargs. * not dependent on any external mock library * can mock constructors using an overloaded constructor for MockFor * can support an instance-style mode rather than the default behaviour-style mode using `proxyInstance()` and `proxyDelegateInstance()` * can support half-mocks using an `ignore` specification on the mock instead of a demand specification * can mock non-existing methods if desired See also: [StubFor](stubfor "StubFor"). Properties Summary ------------------ Properties \| Type \| Name and description \| \| `[Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")` \| `[clazz](#clazz)` \| \| `[Demand](demand)` \| `[demand](#demand)` \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[expect](#expect)` \| \| `[Ignore](ignore)` \| `[ignore](#ignore)` \| \| `[Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")` \| `[instanceExpectations](#instanceExpectations)` \| \| `[MockProxyMetaClass](mockproxymetaclass)` \| `[proxy](#proxy)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[MockFor](#MockFor(java.lang.Class,%20boolean))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") clazz, boolean interceptConstruction)`The optional `interceptConstruction` flag allows mocking of constructor calls. \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `static [GroovyObject](../../lang/groovyobject)` \| `[getInstance](#getInstance(java.lang.Class,%20java.lang.Object))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") clazz, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args)` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[ignore](#ignore(java.lang.Object,%20groovy.lang.Closure))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") filter, [Closure](../../lang/closure) filterBehavior)`Allows particular method calls to be ignored and not treated as part of the required behavior specification. \| \| \| `[GroovyObject](../../lang/groovyobject)` \| `[makeProxyInstance](#makeProxyInstance(java.lang.Object,%20boolean))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args, boolean isDelegate)` \| \| \| `[GroovyObject](../../lang/groovyobject)` \| `[proxyDelegateInstance](#proxyDelegateInstance(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args)`Allows a more traditional instance-style mocking paradigm. \| \| \| `[GroovyObject](../../lang/groovyobject)` \| `[proxyInstance](#proxyInstance(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args)`Allows a more traditional instance-style mocking paradigm. \| \| \| `void` \| `[use](#use(groovy.lang.Closure))([Closure](../../lang/closure) closure)`Identifies the Closure where the mocked collaborator behavior will be applied and verified. \| \| \| `void` \| `[use](#use(groovy.lang.GroovyObject,%20groovy.lang.Closure))([GroovyObject](../../lang/groovyobject) obj, [Closure](../../lang/closure) closure)` \| \| \| `void` \| `[verify](#verify(groovy.lang.GroovyObject))([GroovyObject](../../lang/groovyobject) obj)`If manual verification is required \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Property Detail --------------- ### [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") clazz ### [Demand](demand) demand ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") expect ### [Ignore](ignore) ignore ### [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") instanceExpectations ### [MockProxyMetaClass](mockproxymetaclass) proxy Constructor Detail ------------------ ### MockFor([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") clazz, boolean interceptConstruction) The optional `interceptConstruction` flag allows mocking of constructor calls. These are represented in the demand specification using the class name as this example shows: ``` import groovy.mock.interceptor.MockFor class Person { String first, last } def interceptConstructorCalls = true def mock = new MockFor(Person, interceptConstructorCalls) def dummy = new Person(first:'Tom', last:'Jones') mock.demand.with { Person() { dummy } // expect constructor call, return dummy getFirst() {'John'} getLast() {'Doe'} } mock.use { def p = new Person(first:'Mary', last:'Smith') assert p.first == 'John' assert p.last == 'Doe' } ``` Method Detail ------------- ### static [GroovyObject](../../lang/groovyobject) getInstance([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") clazz, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args) ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ignore([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") filter, [Closure](../../lang/closure) filterBehavior) Allows particular method calls to be ignored and not treated as part of the required behavior specification. If you don't specify a return closure the method call will fall through to the underlying instance, i.e. half-mock style. The `filter` object is invoked using the normal Groovy `isCase()` semantics. Here are some examples: ``` import groovy.mock.interceptor.MockFor class Person { String first, last def name() { "$first $last" } def ignoreMe() { 'baz' } def ignoreMeToo() { ignoreMe() } def ignoreMeThree() { ignoreMe() } } def mock = new MockFor(Person) mock.ignore(~'get.') mock.ignore('ignoreMeToo') { 'boo' } mock.ignore(~'ignoreMe.') mock.demand.name{ 'John' } mock.use { def p = new Person(first:'Mary', last:'Smith') assert p.first == 'Mary' assert p.last == 'Smith' assert p.name() == 'John' assert p.ignoreMe() == 'baz' assert p.ignoreMeToo() == 'boo' assert p.ignoreMeThree() == 'baz' } ``` There is also a convenience form of ignore that matches the same style as demand. E.g. instead of `mock.ignore('hasNext')` you can use `mock.ignore.hasNext()`. A Closure variation is also provided. This convenience shorthand only applies to the `String` form of ignore and cannot be used with methods from `java.lang.Object`. Be careful using this feature while mocking some of the fundamental Java classes like `String` or `Pattern`. As these are used within the implementation of the ignore capability, strange behavior may be observed. ### [GroovyObject](../../lang/groovyobject) makeProxyInstance([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args, boolean isDelegate) ### [GroovyObject](../../lang/groovyobject) proxyDelegateInstance([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args) Allows a more traditional instance-style mocking paradigm. This is the recommended method to call to use the instance-style with Java classes. When mocking interfaces or abstract classes, a compatible proxy instance will be returned. When mocking Java classes, a compatible Groovy class will be generated and proxy instance returned. A MockProxyMetaClass will be instantiated for the class of the instance (i.e. may be on the generated class not the original class). ### [GroovyObject](../../lang/groovyobject) proxyInstance([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args) Allows a more traditional instance-style mocking paradigm. This is the recommended method to call to use the instance-style with Groovy classes. When mocking interfaces or abstract classes, a compatible proxy instance will be returned. When mocking Java classes, a compatible Groovy class will be generated and proxy instance returned. A MockProxyMetaClass will be instantiated for the original class. Typical example: ``` import groovy.mock.interceptor.MockFor class Person { String first, last } class Family { Person mother, father String nameOfMother() { fullName(mother) } String nameOfFather() { fullName(father) } private fullName(p) { "$p.first $p.last" } } def mock = new MockFor(Person) mock.demand.with { getFirst{ 'dummy' } getLast{ 'name' } } Person john = mock.proxyInstance() Person mary = mock.proxyInstance() Family f = new Family(father:john, mother:mary) assert f.nameOfFather() == 'dummy name' assert f.nameOfMother() == 'dummy name' [john, mary].each{ mock.verify(it) } ``` Normally for mocks, `verify()` is call automatically at the end of the "use" Closure, but with this style, no "use" Closure is present, so `verify()` must be called manually. ### void use([Closure](../../lang/closure) closure) Identifies the Closure where the mocked collaborator behavior will be applied and verified. ### void use([GroovyObject](../../lang/groovyobject) obj, [Closure](../../lang/closure) closure) ### void verify([GroovyObject](../../lang/groovyobject) obj) If manual verification is required	programming_docs
groovy [Groovy] Class StubFor [Groovy] Class StubFor ====================== * groovy.mock.interceptor.StubFor ``` class StubFor extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` StubFor supports (typically unit) testing of classes in isolation by allowing a loosely-ordered expectation of the behavior of collaborators to be defined. A typical test scenario involves a class under test (CUT) and one or more collaborators. In such a scenario it is often desirable to just test the business logic of the CUT. One strategy for doing that is to replace the collaborator instances with simplified stub objects to help isolate out the logic in the CUT. StubFor allows such stubs to be created using meta-programming. The desired behavior of collaborators is defined as a behavior specification. The behavior can be checked by the user using verify(). With StubFor, a stub's expectation is sequence independent and use of verify() is left to the user. Typical usage is as follows: < ``` import groovy.mock.interceptor.StubFor class Person { String first, last } class Family { Person mother, father def nameOfFather() { "$father.first $father.last" } } def stub = new StubFor(Person) stub.demand.with { getLast{ 'name' } getFirst{ 'dummy' } } stub.use { def john = new Person(first:'John', last:'Smith') def f = new Family(father:john) assert f.nameOfFather() == 'dummy name' } stub.expect.verify() ``` Here, `Family` is our class under test and `Person` is the collaborator. We are using normal Groovy property semantics here; hence the statement `father.first` causes a call to `father.getFirst()` to occur. For a complete list of features, see: [MockFor](mockfor "MockFor"). Properties Summary ------------------ Properties \| Type \| Name and description \| \| `[Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")` \| `[clazz](#clazz)` \| \| `[Demand](demand)` \| `[demand](#demand)` \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[expect](#expect)` \| \| `[Ignore](ignore)` \| `[ignore](#ignore)` \| \| `[Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")` \| `[instanceExpectations](#instanceExpectations)` \| \| `[MockProxyMetaClass](mockproxymetaclass)` \| `[proxy](#proxy)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[StubFor](#StubFor(java.lang.Class,%20boolean))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") clazz, boolean interceptConstruction)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[ignore](#ignore(java.lang.Object,%20groovy.lang.Closure))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") filter, [Closure](../../lang/closure) filterBehavior)`Allows particular method calls to be ignored and not treated as part of the required behavior specification. \| \| \| `[GroovyObject](../../lang/groovyobject)` \| `[makeProxyInstance](#makeProxyInstance(java.lang.Object,%20boolean))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args, boolean isDelegate)` \| \| \| `[GroovyObject](../../lang/groovyobject)` \| `[proxyDelegateInstance](#proxyDelegateInstance(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args)`Allows a more traditional instance-style stubbing paradigm. \| \| \| `[GroovyObject](../../lang/groovyobject)` \| `[proxyInstance](#proxyInstance(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args)`Allows a more traditional instance-style stubbing paradigm. \| \| \| `void` \| `[use](#use(groovy.lang.Closure))([Closure](../../lang/closure) closure)` See: MockFor#use(Closure) \| \| \| `void` \| `[use](#use(groovy.lang.GroovyObject,%20groovy.lang.Closure))([GroovyObject](../../lang/groovyobject) obj, [Closure](../../lang/closure) closure)` \| \| \| `void` \| `[verify](#verify(groovy.lang.GroovyObject))([GroovyObject](../../lang/groovyobject) obj)`For manual verification \| \| \| `void` \| `[verify](#verify())()`Convenience method \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Property Detail --------------- ### [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") clazz ### [Demand](demand) demand ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") expect ### [Ignore](ignore) ignore ### [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") instanceExpectations ### [MockProxyMetaClass](mockproxymetaclass) proxy Constructor Detail ------------------ ### StubFor([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") clazz, boolean interceptConstruction) Method Detail ------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ignore([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") filter, [Closure](../../lang/closure) filterBehavior) Allows particular method calls to be ignored and not treated as part of the required behavior specification. If you don't specify a return closure the method call will fall through to the underlying instance, i.e. half-mock style. The `filter` object is invoked using the normal Groovy `isCase()` semantics. See: MockFor#ignore(Object, Closure) ### [GroovyObject](../../lang/groovyobject) makeProxyInstance([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args, boolean isDelegate) ### [GroovyObject](../../lang/groovyobject) proxyDelegateInstance([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args) Allows a more traditional instance-style stubbing paradigm. This is the recommended method to call to use the instance-style with Java classes. See: MockFor#proxyDelegateInstance(Object) ### [GroovyObject](../../lang/groovyobject) proxyInstance([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args) Allows a more traditional instance-style stubbing paradigm. This is the recommended method to call to use the instance-style with Groovy classes. See: MockFor#proxyInstance(Object) ### void use([Closure](../../lang/closure) closure) See: MockFor#use(Closure) ### void use([GroovyObject](../../lang/groovyobject) obj, [Closure](../../lang/closure) closure) ### void verify([GroovyObject](../../lang/groovyobject) obj) For manual verification ### void verify() Convenience method groovy [Groovy] Class StrictExpectation [Groovy] Class StrictExpectation ================================ * groovy.mock.interceptor.StrictExpectation ``` class StrictExpectation extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Expects demanded call cardinalities to match demanded ranges in the sequence of recording. See Also: [LooseExpectation](looseexpectation "LooseExpectation") Properties Summary ------------------ Properties \| Type \| Name and description \| \| `int` \| `[fCallSpecIdx](#fCallSpecIdx)` \| \| `[List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")` \| `[fCalls](#fCalls)` \| \| `[Demand](demand)` \| `[fDemand](#fDemand)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[StrictExpectation](#StrictExpectation(groovy.mock.interceptor.Demand))([Demand](demand) demand)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Closure](../../lang/closure)` \| `[match](#match(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name)`Match the requested method name against eligible demands. \| \| \| `void` \| `[verify](#verify())()`verify all calls are in expected range \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Property Detail --------------- ### int fCallSpecIdx ### [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") fCalls ### [Demand](demand) fDemand Constructor Detail ------------------ ### StrictExpectation([Demand](demand) demand) Method Detail ------------- ### [Closure](../../lang/closure) match([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name) Match the requested method name against eligible demands. Fail early if no match possible. Return the demand's behavior closure on match. Also skips over names matching ignore filter, if any. ### void verify() verify all calls are in expected range groovy [Groovy] Class Demand [Groovy] Class Demand ===================== * groovy.mock.interceptor.Demand ``` class Demand extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` The object that registers method calls on it for the use with Mocks and Stubs. For each call a CallSpec object is added to the recorded list. Properties Summary ------------------ Properties \| Type \| Name and description \| \| `[Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")` \| `[ignore](#ignore)` \| \| `[List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")` \| `[recorded](#recorded)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[Demand](#Demand())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[invokeMethod](#invokeMethod(java.lang.String,%20java.lang.Object))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args)` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[verify](#verify(java.util.List))([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") calls)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Property Detail --------------- ### [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") ignore ### [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") recorded Constructor Detail ------------------ ### Demand() Method Detail ------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") invokeMethod([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args) ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") verify([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") calls) groovy [Groovy] Class SwingBuilder [Groovy] Class SwingBuilder =========================== * groovy.swing.SwingBuilder ``` class SwingBuilder extends [FactoryBuilderSupport](../util/factorybuildersupport "FactoryBuilderSupport") ``` A helper class for creating Swing widgets using GroovyMarkup Inherited fields \| Fields inherited from class \| Fields \| \| `class [FactoryBuilderSupport](../util/factorybuildersupport "FactoryBuilderSupport")` \| `CURRENT_FACTORY, PARENT_FACTORY, PARENT_NODE, CURRENT_NODE, PARENT_CONTEXT, PARENT_NAME, CURRENT_NAME, OWNER, PARENT_BUILDER, CURRENT_BUILDER, CHILD_BUILDER, SCRIPT_CLASS_NAME` \| Properties Summary ------------------ Properties \| Type \| Name and description \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DEFAULT\_DELEGATE\_PROPERTY\_OBJECT\_ID](#DEFAULT_DELEGATE_PROPERTY_OBJECT_ID)` \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DELEGATE\_PROPERTY\_OBJECT\_ID](#DELEGATE_PROPERTY_OBJECT_ID)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[SwingBuilder](#SwingBuilder(boolean))(boolean init)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `static [SwingBuilder](swingbuilder)` \| `[$static\_methodMissing](#%24static_methodMissing(java.lang.String,%20java.lang.Object))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") method, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args)`Old factory method static SwingBuilder.build(Closure). \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[build](#build(groovy.lang.Closure))([Closure](../lang/closure) c)`Compatibility API. \| \| \| `static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[clientPropertyAttributeDelegate](#clientPropertyAttributeDelegate(java.lang.Object,%20java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") attributes)` \| \| \| `void` \| `[createKeyStrokeAction](#createKeyStrokeAction(java.util.Map,%20javax.swing.JComponent))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes, [JComponent](https://docs.oracle.com/javase/8/docs/api/javax/swing/JComponent.html "JComponent") component)` \| \| \| `[SwingBuilder](swingbuilder)` \| `[doLater](#doLater(groovy.lang.Closure))([Closure](../lang/closure) c)`Utility method to run a closure in EDT, using `SwingUtilities.invokeLater`. \| \| \| `[SwingBuilder](swingbuilder)` \| `[doOutside](#doOutside(groovy.lang.Closure))([Closure](../lang/closure) c)`Utility method to run a closure outside of the EDT. \| \| \| `[SwingBuilder](swingbuilder)` \| `[edt](#edt(groovy.lang.Closure))([Closure](../lang/closure) c)`Utility method to run a closure in EDT, using `SwingUtilities.invokeAndWait`. \| \| \| `static [SwingBuilder](swingbuilder)` \| `[edtBuilder](#edtBuilder(groovy.lang.Closure))([Closure](../lang/closure) c)`Factory method to create a SwingBuilder, and run the the closure in it on the EDT \| \| \| `static [LookAndFeel](../../lookandfeel)` \| `[lookAndFeel](#lookAndFeel(java.lang.Object,%20groovy.lang.Closure))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") laf, [Closure](../lang/closure) initCode)` \| \| \| `static [LookAndFeel](../../lookandfeel)` \| `[lookAndFeel](#lookAndFeel(java.util.Map,%20java.lang.Object,%20groovy.lang.Closure))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") laf, [Closure](../lang/closure) initCode)` \| \| \| `static [LookAndFeel](../../lookandfeel)` \| `[lookAndFeel](#lookAndFeel(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] lafs)` \| \| \| `static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[objectIDAttributeDelegate](#objectIDAttributeDelegate(java.lang.Object,%20java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") attributes)` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[registerActionButtonWidgets](#registerActionButtonWidgets())()` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[registerBasicLayouts](#registerBasicLayouts())()` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[registerBasicWidgets](#registerBasicWidgets())()` \| \| \| `void` \| `[registerBeanFactory](#registerBeanFactory(java.lang.String,%20java.lang.String,%20java.lang.Class))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") nodeName, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") groupName, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") klass)`Do some overrides for standard component handlers, else use super \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[registerBinding](#registerBinding())()` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[registerBorders](#registerBorders())()` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[registerBoxLayout](#registerBoxLayout())()` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[registerContainers](#registerContainers())()` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[registerDataModels](#registerDataModels())()` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[registerEditors](#registerEditors())()` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[registerMDIWidgets](#registerMDIWidgets())()` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[registerMenuWidgets](#registerMenuWidgets())()` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[registerPassThruNodes](#registerPassThruNodes())()` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[registerRenderers](#registerRenderers())()` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[registerSupportNodes](#registerSupportNodes())()` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[registerTableComponents](#registerTableComponents())()` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[registerTableLayout](#registerTableLayout())()` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[registerTextWidgets](#registerTextWidgets())()` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[registerThreading](#registerThreading())()` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[registerWindows](#registerWindows())()` \| \| \| `[KeyStroke](../../keystroke)` \| `[shortcut](#shortcut(java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") key, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") modifier)` \| \| \| `[KeyStroke](../../keystroke)` \| `[shortcut](#shortcut(java.lang.String,%20java.lang.Object))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") key, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") modifier)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [FactoryBuilderSupport](../util/factorybuildersupport "FactoryBuilderSupport")` \| `[getName](../util/factorybuildersupport#getName(java.lang.String) "getName"), [getProperty](../util/factorybuildersupport#getProperty(java.lang.String) "getProperty"), [setProperty](../util/factorybuildersupport#setProperty(java.lang.String,%20java.lang.Object) "setProperty"), [getContext](../util/factorybuildersupport#getContext() "getContext"), [build](../util/factorybuildersupport#build(java.lang.String,%20groovy.lang.GroovyClassLoader) "build"), [build](../util/factorybuildersupport#build(java.lang.Class) "build"), [build](../util/factorybuildersupport#build(groovy.lang.Script) "build"), [dispose](../util/factorybuildersupport#dispose() "dispose"), [invokeMethod](../util/factorybuildersupport#invokeMethod(java.lang.String,%20java.lang.Object) "invokeMethod"), [invokeMethod](../util/factorybuildersupport#invokeMethod(java.lang.String) "invokeMethod"), [getCurrent](../util/factorybuildersupport#getCurrent() "getCurrent"), [registerFactory](../util/factorybuildersupport#registerFactory(java.lang.String,%20groovy.util.Factory) "registerFactory"), [registerFactory](../util/factorybuildersupport#registerFactory(java.lang.String,%20java.lang.String,%20groovy.util.Factory) "registerFactory"), [getVariable](../util/factorybuildersupport#getVariable(java.lang.String) "getVariable"), [setVariable](../util/factorybuildersupport#setVariable(java.lang.String,%20java.lang.Object) "setVariable"), [getVariables](../util/factorybuildersupport#getVariables() "getVariables"), [getParentNode](../util/factorybuildersupport#getParentNode() "getParentNode"), [getCurrentName](../util/factorybuildersupport#getCurrentName() "getCurrentName"), [autoRegisterNodes](../util/factorybuildersupport#autoRegisterNodes() "autoRegisterNodes"), [getParentName](../util/factorybuildersupport#getParentName() "getParentName"), [getContextAttribute](../util/factorybuildersupport#getContextAttribute(java.lang.String) "getContextAttribute"), [registerBeanFactory](../util/factorybuildersupport#registerBeanFactory(java.lang.String,%20java.lang.String,%20java.lang.Class) "registerBeanFactory"), [registerBeanFactory](../util/factorybuildersupport#registerBeanFactory(java.lang.String,%20java.lang.Class) "registerBeanFactory"), [getPostInstantiateDelegates](../util/factorybuildersupport#getPostInstantiateDelegates() "getPostInstantiateDelegates"), [getLocalExplicitMethods](../util/factorybuildersupport#getLocalExplicitMethods() "getLocalExplicitMethods"), [getPostNodeCompletionDelegates](../util/factorybuildersupport#getPostNodeCompletionDelegates() "getPostNodeCompletionDelegates"), [getRegistrationGroupItems](../util/factorybuildersupport#getRegistrationGroupItems(java.lang.String) "getRegistrationGroupItems"), [getMethodMissingDelegate](../util/factorybuildersupport#getMethodMissingDelegate() "getMethodMissingDelegate"), [getPropertyMissingDelegate](../util/factorybuildersupport#getPropertyMissingDelegate() "getPropertyMissingDelegate"), [setPropertyMissingDelegate](../util/factorybuildersupport#setPropertyMissingDelegate(groovy.lang.Closure) "setPropertyMissingDelegate"), [addAttributeDelegate](../util/factorybuildersupport#addAttributeDelegate(groovy.lang.Closure) "addAttributeDelegate"), [addPostInstantiateDelegate](../util/factorybuildersupport#addPostInstantiateDelegate(groovy.lang.Closure) "addPostInstantiateDelegate"), [getRegistrationGroups](../util/factorybuildersupport#getRegistrationGroups() "getRegistrationGroups"), [registerExplicitProperty](../util/factorybuildersupport#registerExplicitProperty(java.lang.String,%20groovy.lang.Closure,%20groovy.lang.Closure) "registerExplicitProperty"), [registerExplicitProperty](../util/factorybuildersupport#registerExplicitProperty(java.lang.String,%20java.lang.String,%20groovy.lang.Closure,%20groovy.lang.Closure) "registerExplicitProperty"), [getExplicitProperties](../util/factorybuildersupport#getExplicitProperties() "getExplicitProperties"), [getLocalExplicitProperties](../util/factorybuildersupport#getLocalExplicitProperties() "getLocalExplicitProperties"), [setMethodMissingDelegate](../util/factorybuildersupport#setMethodMissingDelegate(groovy.lang.Closure) "setMethodMissingDelegate"), [registerExplicitMethod](../util/factorybuildersupport#registerExplicitMethod(java.lang.String,%20groovy.lang.Closure) "registerExplicitMethod"), [registerExplicitMethod](../util/factorybuildersupport#registerExplicitMethod(java.lang.String,%20java.lang.String,%20groovy.lang.Closure) "registerExplicitMethod"), [addPostNodeCompletionDelegate](../util/factorybuildersupport#addPostNodeCompletionDelegate(groovy.lang.Closure) "addPostNodeCompletionDelegate"), [removePostInstantiateDelegate](../util/factorybuildersupport#removePostInstantiateDelegate(groovy.lang.Closure) "removePostInstantiateDelegate"), [removeAttributeDelegate](../util/factorybuildersupport#removeAttributeDelegate(groovy.lang.Closure) "removeAttributeDelegate"), [getNameMappingClosure](../util/factorybuildersupport#getNameMappingClosure() "getNameMappingClosure"), [getPreInstantiateDelegates](../util/factorybuildersupport#getPreInstantiateDelegates() "getPreInstantiateDelegates"), [addPreInstantiateDelegate](../util/factorybuildersupport#addPreInstantiateDelegate(groovy.lang.Closure) "addPreInstantiateDelegate"), [getAttributeDelegates](../util/factorybuildersupport#getAttributeDelegates() "getAttributeDelegates"), [removePreInstantiateDelegate](../util/factorybuildersupport#removePreInstantiateDelegate(groovy.lang.Closure) "removePreInstantiateDelegate"), [removePostNodeCompletionDelegate](../util/factorybuildersupport#removePostNodeCompletionDelegate(groovy.lang.Closure) "removePostNodeCompletionDelegate"), [setNameMappingClosure](../util/factorybuildersupport#setNameMappingClosure(groovy.lang.Closure) "setNameMappingClosure"), [checkValueIsTypeNotString](../util/factorybuildersupport#checkValueIsTypeNotString(java.lang.Object,%20java.lang.Object,%20java.lang.Class) "checkValueIsTypeNotString"), [getDisposalClosures](../util/factorybuildersupport#getDisposalClosures() "getDisposalClosures"), [getChildBuilder](../util/factorybuildersupport#getChildBuilder() "getChildBuilder"), [getFactories](../util/factorybuildersupport#getFactories() "getFactories"), [getExplicitMethods](../util/factorybuildersupport#getExplicitMethods() "getExplicitMethods"), [getParentFactory](../util/factorybuildersupport#getParentFactory() "getParentFactory"), [getCurrentBuilder](../util/factorybuildersupport#getCurrentBuilder() "getCurrentBuilder"), [withBuilder](../util/factorybuildersupport#withBuilder(groovy.util.FactoryBuilderSupport,%20groovy.lang.Closure) "withBuilder"), [withBuilder](../util/factorybuildersupport#withBuilder(groovy.util.FactoryBuilderSupport,%20java.lang.String,%20groovy.lang.Closure) "withBuilder"), [withBuilder](../util/factorybuildersupport#withBuilder(java.util.Map,%20groovy.util.FactoryBuilderSupport,%20java.lang.String,%20groovy.lang.Closure) "withBuilder"), [getCurrentFactory](../util/factorybuildersupport#getCurrentFactory() "getCurrentFactory"), [checkValueIsNull](../util/factorybuildersupport#checkValueIsNull(java.lang.Object,%20java.lang.Object) "checkValueIsNull"), [checkValueIsType](../util/factorybuildersupport#checkValueIsType(java.lang.Object,%20java.lang.Object,%20java.lang.Class) "checkValueIsType"), [getParentContext](../util/factorybuildersupport#getParentContext() "getParentContext"), [getLocalFactories](../util/factorybuildersupport#getLocalFactories() "getLocalFactories"), [addDisposalClosure](../util/factorybuildersupport#addDisposalClosure(groovy.lang.Closure) "addDisposalClosure"), [hasVariable](../util/factorybuildersupport#hasVariable(java.lang.String) "hasVariable"), [removeVariable](../util/factorybuildersupport#removeVariable(java.lang.String) "removeVariable"), [setMetaClass](../util/factorybuildersupport#setMetaClass(groovy.lang.MetaClass) "setMetaClass"), [getMetaClass](../util/factorybuildersupport#getMetaClass() "getMetaClass"), [wait](../util/factorybuildersupport#wait(long,%20int) "wait"), [wait](../util/factorybuildersupport#wait() "wait"), [wait](../util/factorybuildersupport#wait(long) "wait"), [equals](../util/factorybuildersupport#equals(java.lang.Object) "equals"), [toString](../util/factorybuildersupport#toString() "toString"), [hashCode](../util/factorybuildersupport#hashCode() "hashCode"), [getClass](../util/factorybuildersupport#getClass() "getClass"), [notify](../util/factorybuildersupport#notify() "notify"), [notifyAll](../util/factorybuildersupport#notifyAll() "notifyAll")` \| Property Detail --------------- ### static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DEFAULT\_DELEGATE\_PROPERTY\_OBJECT\_ID ### static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DELEGATE\_PROPERTY\_OBJECT\_ID Constructor Detail ------------------ ### SwingBuilder(boolean init) Method Detail ------------- ### @[Deprecated](https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html "Deprecated") static [SwingBuilder](swingbuilder) $static\_methodMissing([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") method, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args) Old factory method static SwingBuilder.build(Closure). Parameters: `c` - run this closure in the builder using the edt method ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") build(@[DelegatesTo](../lang/delegatesto "DelegatesTo")(value: SwingBuilder) [Closure](../lang/closure) c) Compatibility API. Parameters: `c` - run this closure in the builder ### static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") clientPropertyAttributeDelegate([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") attributes) ### void createKeyStrokeAction([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes, [JComponent](https://docs.oracle.com/javase/8/docs/api/javax/swing/JComponent.html "JComponent") component) ### [SwingBuilder](swingbuilder) doLater(@[DelegatesTo](../lang/delegatesto "DelegatesTo")(value: SwingBuilder) [Closure](../lang/closure) c) Utility method to run a closure in EDT, using `SwingUtilities.invokeLater`. Parameters: `c` - this closure is run in the EDT ### [SwingBuilder](swingbuilder) doOutside(@[DelegatesTo](../lang/delegatesto "DelegatesTo")(value: SwingBuilder) [Closure](../lang/closure) c) Utility method to run a closure outside of the EDT. The closure is wrapped in a thread, and the thread is started immediately, only if the current thread is the EDT, otherwise the closure will be called immediately. Parameters: `c` - this closure is started outside of the EDT ### [SwingBuilder](swingbuilder) edt(@[DelegatesTo](../lang/delegatesto "DelegatesTo")(value: SwingBuilder) [Closure](../lang/closure) c) Utility method to run a closure in EDT, using `SwingUtilities.invokeAndWait`. Parameters: `c` - this closure is run in the EDT ### static [SwingBuilder](swingbuilder) edtBuilder(@[DelegatesTo](../lang/delegatesto "DelegatesTo")(value: SwingBuilder) [Closure](../lang/closure) c) Factory method to create a SwingBuilder, and run the the closure in it on the EDT Parameters: `c` - run this closure in the new builder using the edt method ### static [LookAndFeel](../../lookandfeel) lookAndFeel([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") laf, [Closure](../lang/closure) initCode) ### static [LookAndFeel](../../lookandfeel) lookAndFeel([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") laf, [Closure](../lang/closure) initCode) ### static [LookAndFeel](../../lookandfeel) lookAndFeel([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] lafs) ### static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") objectIDAttributeDelegate([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") attributes) ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") registerActionButtonWidgets() ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") registerBasicLayouts() ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") registerBasicWidgets() ### void registerBeanFactory([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") nodeName, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") groupName, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") klass) Do some overrides for standard component handlers, else use super ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") registerBinding() ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") registerBorders() ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") registerBoxLayout() ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") registerContainers() ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") registerDataModels() ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") registerEditors() ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") registerMDIWidgets() ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") registerMenuWidgets() ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") registerPassThruNodes() ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") registerRenderers() ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") registerSupportNodes() ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") registerTableComponents() ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") registerTableLayout() ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") registerTextWidgets() ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") registerThreading() ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") registerWindows() ### [KeyStroke](../../keystroke) shortcut([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") key, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") modifier) ### [KeyStroke](../../keystroke) shortcut([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") key, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") modifier)	programming_docs
groovy [Groovy] Class LookAndFeelHelper [Groovy] Class LookAndFeelHelper ================================ * groovy.swing.LookAndFeelHelper ``` class LookAndFeelHelper extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `protected static [LookAndFeelHelper](lookandfeelhelper)` \| `[instance](#instance)` \| \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[addLookAndFeelAlias](#addLookAndFeelAlias(java.lang.String,%20java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") alias, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") className)` \| \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[addLookAndFeelAttributeHandler](#addLookAndFeelAttributeHandler(java.lang.String,%20java.lang.String,%20groovy.lang.Closure))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") className, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") attr, [Closure](../lang/closure) handler)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getAquaLAFName](#getAquaLAFName())()` \| \| \| `static [LookAndFeelHelper](lookandfeelhelper)` \| `[getInstance](#getInstance())()` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getNimbusLAFName](#getNimbusLAFName())()` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getSubstanceLAFName](#getSubstanceLAFName())()` \| \| \| `boolean` \| `[isLeaf](#isLeaf())()` \| \| \| `[LookAndFeel](../../lookandfeel)` \| `[lookAndFeel](#lookAndFeel(java.lang.Object,%20java.util.Map,%20groovy.lang.Closure))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes, [Closure](../lang/closure) initClosure)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Field Detail ------------ ### protected static [LookAndFeelHelper](lookandfeelhelper) instance Method Detail ------------- ### [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") addLookAndFeelAlias([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") alias, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") className) ### [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") addLookAndFeelAttributeHandler([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") className, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") attr, [Closure](../lang/closure) handler) ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getAquaLAFName() ### static [LookAndFeelHelper](lookandfeelhelper) getInstance() ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getNimbusLAFName() ### static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getSubstanceLAFName() ### boolean isLeaf() ### [LookAndFeel](../../lookandfeel) lookAndFeel([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes, [Closure](../lang/closure) initClosure) groovy [Java] Class DefaultAction [Java] Class DefaultAction ========================== * groovy.swing.impl.DefaultAction ``` public class DefaultAction extends [AbstractAction](https://docs.oracle.com/javase/8/docs/api/javax/swing/AbstractAction.html "AbstractAction") ``` A default action implementation Inherited fields \| Fields inherited from class \| Fields \| \| `class [AbstractAction](https://docs.oracle.com/javase/8/docs/api/javax/swing/AbstractAction.html "AbstractAction")` \| `DEFAULT, NAME, SHORT_DESCRIPTION, LONG_DESCRIPTION, SMALL_ICON, ACTION_COMMAND_KEY, ACCELERATOR_KEY, MNEMONIC_KEY, SELECTED_KEY, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public void` \| `[actionPerformed](#actionPerformed(java.awt.event.ActionEvent))([ActionEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/ActionEvent.html "ActionEvent") event)` \| \| \| `public [Closure](../../lang/closure)` \| `[getClosure](#getClosure())()` \| \| \| `public void` \| `[setClosure](#setClosure(groovy.lang.Closure))([Closure](../../lang/closure) closure)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractAction](https://docs.oracle.com/javase/8/docs/api/javax/swing/AbstractAction.html "AbstractAction")` \| `[getValue](https://docs.oracle.com/javase/8/docs/api/javax/swing/AbstractAction.html#getValue(java.lang.String) "getValue"), [getKeys](https://docs.oracle.com/javase/8/docs/api/javax/swing/AbstractAction.html#getKeys() "getKeys"), [putValue](https://docs.oracle.com/javase/8/docs/api/javax/swing/AbstractAction.html#putValue(java.lang.String,%20java.lang.Object) "putValue"), [isEnabled](https://docs.oracle.com/javase/8/docs/api/javax/swing/AbstractAction.html#isEnabled() "isEnabled"), [setEnabled](https://docs.oracle.com/javase/8/docs/api/javax/swing/AbstractAction.html#setEnabled(boolean) "setEnabled"), [getPropertyChangeListeners](https://docs.oracle.com/javase/8/docs/api/javax/swing/AbstractAction.html#getPropertyChangeListeners() "getPropertyChangeListeners"), [removePropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/AbstractAction.html#removePropertyChangeListener(java.beans.PropertyChangeListener) "removePropertyChangeListener"), [addPropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/AbstractAction.html#addPropertyChangeListener(java.beans.PropertyChangeListener) "addPropertyChangeListener"), [wait](https://docs.oracle.com/javase/8/docs/api/javax/swing/AbstractAction.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/javax/swing/AbstractAction.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/javax/swing/AbstractAction.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/javax/swing/AbstractAction.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/javax/swing/AbstractAction.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/javax/swing/AbstractAction.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/javax/swing/AbstractAction.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/javax/swing/AbstractAction.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/javax/swing/AbstractAction.html#notifyAll() "notifyAll"), [accept](https://docs.oracle.com/javase/8/docs/api/javax/swing/AbstractAction.html#accept(java.lang.Object) "accept"), [actionPerformed](https://docs.oracle.com/javase/8/docs/api/javax/swing/AbstractAction.html#actionPerformed(java.awt.event.ActionEvent) "actionPerformed")` \| Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void actionPerformed([ActionEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/ActionEvent.html "ActionEvent") event) ### public [Closure](../../lang/closure) getClosure() ### public void setClosure([Closure](../../lang/closure) closure) groovy [Java] Class TableLayoutRow [Java] Class TableLayoutRow =========================== * groovy.swing.impl.TableLayoutRow ``` public class TableLayoutRow extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Represents a row in a table layout Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[TableLayoutRow](#TableLayoutRow(groovy.swing.impl.TableLayout))([TableLayout](tablelayout) tableLayoutTag)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public void` \| `[addCell](#addCell(groovy.swing.impl.TableLayoutCell))([TableLayoutCell](tablelayoutcell) tag)`Adds a new cell to this row \| \| \| `public void` \| `[addComponentsForRow](#addComponentsForRow())()` \| \| \| `public int` \| `[getRowIndex](#getRowIndex())()` Returns: the row index of this row \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public TableLayoutRow([TableLayout](tablelayout) tableLayoutTag) Method Detail ------------- ### public void addCell([TableLayoutCell](tablelayoutcell) tag) Adds a new cell to this row Parameters: `tag` - the td element ### public void addComponentsForRow() ### public int getRowIndex() Returns: the row index of this row groovy [Java] Class TableLayout [Java] Class TableLayout ======================== * groovy.swing.impl.TableLayout ``` public class TableLayout extends [JPanel](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html "JPanel") ``` Represents a HTML style table layout Inherited fields \| Fields inherited from class \| Fields \| \| `class [JPanel](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html "JPanel")` \| `WHEN_FOCUSED, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_IN_FOCUSED_WINDOW, UNDEFINED_CONDITION, TOOL_TIP_TEXT_KEY, TOP_ALIGNMENT, CENTER_ALIGNMENT, BOTTOM_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, WIDTH, HEIGHT, PROPERTIES, SOMEBITS, FRAMEBITS, ALLBITS, ERROR, ABORT` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[TableLayout](#TableLayout())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public void` \| `[addCell](#addCell(groovy.swing.impl.TableLayoutCell))([TableLayoutCell](tablelayoutcell) cell)`Adds a new cell to the current grid \| \| \| `public int` \| `[getCellpadding](#getCellpadding())()` \| \| \| `public int` \| `[nextRowIndex](#nextRowIndex())()`Creates a new row index for child tr tags \| \| \| `public void` \| `[setCellpadding](#setCellpadding(int))(int cellpadding)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [JPanel](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html "JPanel")` \| `[updateUI](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#updateUI() "updateUI"), [setUI](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setUI(javax.swing.plaf.PanelUI) "setUI"), [getUI](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getUI() "getUI"), [getUI](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getUI() "getUI"), [getUIClassID](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getUIClassID() "getUIClassID"), [getAccessibleContext](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getAccessibleContext() "getAccessibleContext"), [update](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#update(java.awt.Graphics) "update"), [contains](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#contains(int,%20int) "contains"), [getBounds](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getBounds(java.awt.Rectangle) "getBounds"), [getLocation](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getLocation(java.awt.Point) "getLocation"), [print](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#print(java.awt.Graphics) "print"), [getSize](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getSize(java.awt.Dimension) "getSize"), [setOpaque](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setOpaque(boolean) "setOpaque"), [isOpaque](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#isOpaque() "isOpaque"), [enable](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#enable() "enable"), [disable](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#disable() "disable"), [setEnabled](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setEnabled(boolean) "setEnabled"), [getVetoableChangeListeners](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getVetoableChangeListeners() "getVetoableChangeListeners"), [removeAncestorListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#removeAncestorListener(javax.swing.event.AncestorListener) "removeAncestorListener"), [getAncestorListeners](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getAncestorListeners() "getAncestorListeners"), [addNotify](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#addNotify() "addNotify"), [removeNotify](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#removeNotify() "removeNotify"), [paintImmediately](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#paintImmediately(int,%20int,%20int,%20int) "paintImmediately"), [paintImmediately](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#paintImmediately(java.awt.Rectangle) "paintImmediately"), [hide](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#hide() "hide"), [setInheritsPopupMenu](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setInheritsPopupMenu(boolean) "setInheritsPopupMenu"), [setComponentPopupMenu](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setComponentPopupMenu(javax.swing.JPopupMenu) "setComponentPopupMenu"), [isPaintingTile](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#isPaintingTile() "isPaintingTile"), [isPaintingForPrint](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#isPaintingForPrint() "isPaintingForPrint"), [setRequestFocusEnabled](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setRequestFocusEnabled(boolean) "setRequestFocusEnabled"), [isRequestFocusEnabled](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#isRequestFocusEnabled() "isRequestFocusEnabled"), [grabFocus](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#grabFocus() "grabFocus"), [setVerifyInputWhenFocusTarget](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setVerifyInputWhenFocusTarget(boolean) "setVerifyInputWhenFocusTarget"), [getVerifyInputWhenFocusTarget](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getVerifyInputWhenFocusTarget() "getVerifyInputWhenFocusTarget"), [setBorder](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setBorder(javax.swing.border.Border) "setBorder"), [setAlignmentY](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setAlignmentY(float) "setAlignmentY"), [setAlignmentX](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setAlignmentX(float) "setAlignmentX"), [setInputVerifier](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setInputVerifier(javax.swing.InputVerifier) "setInputVerifier"), [getInputVerifier](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getInputVerifier() "getInputVerifier"), [setDebugGraphicsOptions](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setDebugGraphicsOptions(int) "setDebugGraphicsOptions"), [getDebugGraphicsOptions](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getDebugGraphicsOptions() "getDebugGraphicsOptions"), [unregisterKeyboardAction](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#unregisterKeyboardAction(javax.swing.KeyStroke) "unregisterKeyboardAction"), [getRegisteredKeyStrokes](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getRegisteredKeyStrokes() "getRegisteredKeyStrokes"), [getConditionForKeyStroke](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getConditionForKeyStroke(javax.swing.KeyStroke) "getConditionForKeyStroke"), [getActionForKeyStroke](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getActionForKeyStroke(javax.swing.KeyStroke) "getActionForKeyStroke"), [resetKeyboardActions](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#resetKeyboardActions() "resetKeyboardActions"), [requestDefaultFocus](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#requestDefaultFocus() "requestDefaultFocus"), [setToolTipText](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setToolTipText(java.lang.String) "setToolTipText"), [getToolTipLocation](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getToolTipLocation(java.awt.event.MouseEvent) "getToolTipLocation"), [getPopupLocation](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getPopupLocation(java.awt.event.MouseEvent) "getPopupLocation"), [createToolTip](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#createToolTip() "createToolTip"), [getAutoscrolls](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getAutoscrolls() "getAutoscrolls"), [setTransferHandler](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setTransferHandler(javax.swing.TransferHandler) "setTransferHandler"), [getTransferHandler](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getTransferHandler() "getTransferHandler"), [getVisibleRect](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getVisibleRect() "getVisibleRect"), [getTopLevelAncestor](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getTopLevelAncestor() "getTopLevelAncestor"), [isValidateRoot](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#isValidateRoot() "isValidateRoot"), [setDoubleBuffered](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setDoubleBuffered(boolean) "setDoubleBuffered"), [addAncestorListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#addAncestorListener(javax.swing.event.AncestorListener) "addAncestorListener"), [firePropertyChange](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#firePropertyChange(java.lang.String,%20int,%20int) "firePropertyChange"), [firePropertyChange](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#firePropertyChange(java.lang.String,%20boolean,%20boolean) "firePropertyChange"), [firePropertyChange](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#firePropertyChange(java.lang.String,%20char,%20char) "firePropertyChange"), [getListeners](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getListeners(java.lang.Class) "getListeners"), [getClientProperty](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getClientProperty(java.lang.Object) "getClientProperty"), [getGraphics](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getGraphics() "getGraphics"), [getRootPane](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getRootPane() "getRootPane"), [getInheritsPopupMenu](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getInheritsPopupMenu() "getInheritsPopupMenu"), [getComponentPopupMenu](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getComponentPopupMenu() "getComponentPopupMenu"), [isManagingFocus](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#isManagingFocus() "isManagingFocus"), [getDefaultLocale](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getDefaultLocale() "getDefaultLocale"), [repaint](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#repaint(long,%20int,%20int,%20int,%20int) "repaint"), [repaint](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#repaint(java.awt.Rectangle) "repaint"), [putClientProperty](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#putClientProperty(java.lang.Object,%20java.lang.Object) "putClientProperty"), [setFont](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setFont(java.awt.Font) "setFont"), [isOptimizedDrawingEnabled](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#isOptimizedDrawingEnabled() "isOptimizedDrawingEnabled"), [getWidth](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getWidth() "getWidth"), [getHeight](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getHeight() "getHeight"), [isLightweightComponent](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#isLightweightComponent(java.awt.Component) "isLightweightComponent"), [paint](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#paint(java.awt.Graphics) "paint"), [printAll](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#printAll(java.awt.Graphics) "printAll"), [getBorder](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getBorder() "getBorder"), [isDoubleBuffered](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#isDoubleBuffered() "isDoubleBuffered"), [getNextFocusableComponent](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getNextFocusableComponent() "getNextFocusableComponent"), [setNextFocusableComponent](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setNextFocusableComponent(java.awt.Component) "setNextFocusableComponent"), [requestFocus](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#requestFocus(boolean) "requestFocus"), [requestFocus](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#requestFocus() "requestFocus"), [requestFocusInWindow](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#requestFocusInWindow() "requestFocusInWindow"), [getFontMetrics](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getFontMetrics(java.awt.Font) "getFontMetrics"), [setPreferredSize](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setPreferredSize(java.awt.Dimension) "setPreferredSize"), [getPreferredSize](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getPreferredSize() "getPreferredSize"), [setMaximumSize](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setMaximumSize(java.awt.Dimension) "setMaximumSize"), [getMaximumSize](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getMaximumSize() "getMaximumSize"), [setMinimumSize](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setMinimumSize(java.awt.Dimension) "setMinimumSize"), [getMinimumSize](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getMinimumSize() "getMinimumSize"), [getInsets](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getInsets() "getInsets"), [getInsets](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getInsets(java.awt.Insets) "getInsets"), [getAlignmentY](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getAlignmentY() "getAlignmentY"), [getAlignmentX](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getAlignmentX() "getAlignmentX"), [getInputMap](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getInputMap(int) "getInputMap"), [getInputMap](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getInputMap() "getInputMap"), [getActionMap](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getActionMap() "getActionMap"), [registerKeyboardAction](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#registerKeyboardAction(java.awt.event.ActionListener,%20javax.swing.KeyStroke,%20int) "registerKeyboardAction"), [registerKeyboardAction](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#registerKeyboardAction(java.awt.event.ActionListener,%20java.lang.String,%20javax.swing.KeyStroke,%20int) "registerKeyboardAction"), [setInputMap](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setInputMap(int,%20javax.swing.InputMap) "setInputMap"), [setActionMap](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setActionMap(javax.swing.ActionMap) "setActionMap"), [getBaseline](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getBaseline(int,%20int) "getBaseline"), [getBaselineResizeBehavior](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getBaselineResizeBehavior() "getBaselineResizeBehavior"), [setForeground](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setForeground(java.awt.Color) "setForeground"), [setBackground](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setBackground(java.awt.Color) "setBackground"), [setDefaultLocale](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setDefaultLocale(java.util.Locale) "setDefaultLocale"), [getToolTipText](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getToolTipText() "getToolTipText"), [getToolTipText](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getToolTipText(java.awt.event.MouseEvent) "getToolTipText"), [scrollRectToVisible](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#scrollRectToVisible(java.awt.Rectangle) "scrollRectToVisible"), [setAutoscrolls](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setAutoscrolls(boolean) "setAutoscrolls"), [setFocusTraversalKeys](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setFocusTraversalKeys(int,%20java.util.Set) "setFocusTraversalKeys"), [reshape](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#reshape(int,%20int,%20int,%20int) "reshape"), [computeVisibleRect](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#computeVisibleRect(java.awt.Rectangle) "computeVisibleRect"), [addVetoableChangeListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#addVetoableChangeListener(java.beans.VetoableChangeListener) "addVetoableChangeListener"), [removeVetoableChangeListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#removeVetoableChangeListener(java.beans.VetoableChangeListener) "removeVetoableChangeListener"), [revalidate](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#revalidate() "revalidate"), [setVisible](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setVisible(boolean) "setVisible"), [getY](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getY() "getY"), [getX](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getX() "getX"), [add](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#add(java.awt.Component) "add"), [add](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#add(java.lang.String,%20java.awt.Component) "add"), [add](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#add(java.awt.Component,%20java.lang.Object) "add"), [add](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#add(java.awt.Component,%20int) "add"), [add](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#add(java.awt.Component,%20java.lang.Object,%20int) "add"), [remove](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#remove(java.awt.Component) "remove"), [remove](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#remove(int) "remove"), [list](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#list(java.io.PrintWriter,%20int) "list"), [list](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#list(java.io.PrintStream,%20int) "list"), [validate](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#validate() "validate"), [removeAll](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#removeAll() "removeAll"), [invalidate](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#invalidate() "invalidate"), [locate](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#locate(int,%20int) "locate"), [getComponent](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getComponent(int) "getComponent"), [layout](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#layout() "layout"), [preferredSize](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#preferredSize() "preferredSize"), [minimumSize](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#minimumSize() "minimumSize"), [insets](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#insets() "insets"), [countComponents](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#countComponents() "countComponents"), [getComponentZOrder](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getComponentZOrder(java.awt.Component) "getComponentZOrder"), [doLayout](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#doLayout() "doLayout"), [deliverEvent](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#deliverEvent(java.awt.Event) "deliverEvent"), [findComponentAt](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#findComponentAt(int,%20int) "findComponentAt"), [findComponentAt](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#findComponentAt(java.awt.Point) "findComponentAt"), [isFocusTraversalPolicyProvider](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#isFocusTraversalPolicyProvider() "isFocusTraversalPolicyProvider"), [applyComponentOrientation](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#applyComponentOrientation(java.awt.ComponentOrientation) "applyComponentOrientation"), [addContainerListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#addContainerListener(java.awt.event.ContainerListener) "addContainerListener"), [setComponentZOrder](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setComponentZOrder(java.awt.Component,%20int) "setComponentZOrder"), [setLayout](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setLayout(java.awt.LayoutManager) "setLayout"), [paintComponents](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#paintComponents(java.awt.Graphics) "paintComponents"), [printComponents](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#printComponents(java.awt.Graphics) "printComponents"), [removeContainerListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#removeContainerListener(java.awt.event.ContainerListener) "removeContainerListener"), [getContainerListeners](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getContainerListeners() "getContainerListeners"), [getMousePosition](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getMousePosition(boolean) "getMousePosition"), [isAncestorOf](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#isAncestorOf(java.awt.Component) "isAncestorOf"), [getFocusTraversalKeys](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getFocusTraversalKeys(int) "getFocusTraversalKeys"), [areFocusTraversalKeysSet](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#areFocusTraversalKeysSet(int) "areFocusTraversalKeysSet"), [isFocusTraversalPolicySet](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#isFocusTraversalPolicySet() "isFocusTraversalPolicySet"), [setFocusCycleRoot](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setFocusCycleRoot(boolean) "setFocusCycleRoot"), [setFocusTraversalPolicyProvider](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setFocusTraversalPolicyProvider(boolean) "setFocusTraversalPolicyProvider"), [transferFocusDownCycle](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#transferFocusDownCycle() "transferFocusDownCycle"), [isFocusCycleRoot](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#isFocusCycleRoot() "isFocusCycleRoot"), [isFocusCycleRoot](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#isFocusCycleRoot(java.awt.Container) "isFocusCycleRoot"), [getFocusTraversalPolicy](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getFocusTraversalPolicy() "getFocusTraversalPolicy"), [setFocusTraversalPolicy](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setFocusTraversalPolicy(java.awt.FocusTraversalPolicy) "setFocusTraversalPolicy"), [getLayout](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getLayout() "getLayout"), [getComponents](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getComponents() "getComponents"), [getComponentCount](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getComponentCount() "getComponentCount"), [getComponentAt](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getComponentAt(int,%20int) "getComponentAt"), [getComponentAt](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getComponentAt(java.awt.Point) "getComponentAt"), [addPropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#addPropertyChangeListener(java.lang.String,%20java.beans.PropertyChangeListener) "addPropertyChangeListener"), [addPropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#addPropertyChangeListener(java.beans.PropertyChangeListener) "addPropertyChangeListener"), [getName](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getName() "getName"), [add](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#add(java.awt.PopupMenu) "add"), [remove](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#remove(java.awt.MenuComponent) "remove"), [toString](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#toString() "toString"), [size](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#size() "size"), [contains](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#contains(java.awt.Point) "contains"), [list](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#list() "list"), [list](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#list(java.io.PrintWriter) "list"), [list](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#list(java.io.PrintStream) "list"), [getBounds](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getBounds() "getBounds"), [bounds](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#bounds() "bounds"), [getLocation](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getLocation() "getLocation"), [getParent](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getParent() "getParent"), [action](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#action(java.awt.Event,%20java.lang.Object) "action"), [setName](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setName(java.lang.String) "setName"), [location](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#location() "location"), [getSize](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getSize() "getSize"), [resize](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#resize(java.awt.Dimension) "resize"), [resize](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#resize(int,%20int) "resize"), [move](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#move(int,%20int) "move"), [setSize](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setSize(int,%20int) "setSize"), [setSize](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setSize(java.awt.Dimension) "setSize"), [getLocale](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getLocale() "getLocale"), [isEnabled](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#isEnabled() "isEnabled"), [enable](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#enable(boolean) "enable"), [setLocale](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setLocale(java.util.Locale) "setLocale"), [isValid](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#isValid() "isValid"), [dispatchEvent](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#dispatchEvent(java.awt.AWTEvent) "dispatchEvent"), [mouseEnter](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#mouseEnter(java.awt.Event,%20int,%20int) "mouseEnter"), [mouseExit](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#mouseExit(java.awt.Event,%20int,%20int) "mouseExit"), [mouseMove](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#mouseMove(java.awt.Event,%20int,%20int) "mouseMove"), [mouseDown](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#mouseDown(java.awt.Event,%20int,%20int) "mouseDown"), [mouseDrag](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#mouseDrag(java.awt.Event,%20int,%20int) "mouseDrag"), [mouseUp](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#mouseUp(java.awt.Event,%20int,%20int) "mouseUp"), [keyDown](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#keyDown(java.awt.Event,%20int) "keyDown"), [keyUp](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#keyUp(java.awt.Event,%20int) "keyUp"), [gotFocus](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#gotFocus(java.awt.Event,%20java.lang.Object) "gotFocus"), [lostFocus](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#lostFocus(java.awt.Event,%20java.lang.Object) "lostFocus"), [isFocusTraversable](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#isFocusTraversable() "isFocusTraversable"), [hasFocus](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#hasFocus() "hasFocus"), [addComponentListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#addComponentListener(java.awt.event.ComponentListener) "addComponentListener"), [addFocusListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#addFocusListener(java.awt.event.FocusListener) "addFocusListener"), [addKeyListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#addKeyListener(java.awt.event.KeyListener) "addKeyListener"), [addMouseListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#addMouseListener(java.awt.event.MouseListener) "addMouseListener"), [addMouseMotionListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#addMouseMotionListener(java.awt.event.MouseMotionListener) "addMouseMotionListener"), [addInputMethodListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#addInputMethodListener(java.awt.event.InputMethodListener) "addInputMethodListener"), [addHierarchyListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#addHierarchyListener(java.awt.event.HierarchyListener) "addHierarchyListener"), [addHierarchyBoundsListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#addHierarchyBoundsListener(java.awt.event.HierarchyBoundsListener) "addHierarchyBoundsListener"), [addMouseWheelListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#addMouseWheelListener(java.awt.event.MouseWheelListener) "addMouseWheelListener"), [setComponentOrientation](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setComponentOrientation(java.awt.ComponentOrientation) "setComponentOrientation"), [setDropTarget](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setDropTarget(java.awt.dnd.DropTarget) "setDropTarget"), [getDropTarget](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getDropTarget() "getDropTarget"), [enableInputMethods](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#enableInputMethods(boolean) "enableInputMethods"), [isForegroundSet](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#isForegroundSet() "isForegroundSet"), [isBackgroundSet](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#isBackgroundSet() "isBackgroundSet"), [isFontSet](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#isFontSet() "isFontSet"), [setCursor](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setCursor(java.awt.Cursor) "setCursor"), [getCursor](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getCursor() "getCursor"), [isCursorSet](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#isCursorSet() "isCursorSet"), [paintAll](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#paintAll(java.awt.Graphics) "paintAll"), [imageUpdate](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#imageUpdate(java.awt.Image,%20int,%20int,%20int,%20int,%20int) "imageUpdate"), [setIgnoreRepaint](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setIgnoreRepaint(boolean) "setIgnoreRepaint"), [getIgnoreRepaint](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getIgnoreRepaint() "getIgnoreRepaint"), [removeComponentListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#removeComponentListener(java.awt.event.ComponentListener) "removeComponentListener"), [getComponentListeners](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getComponentListeners() "getComponentListeners"), [removeFocusListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#removeFocusListener(java.awt.event.FocusListener) "removeFocusListener"), [getFocusListeners](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getFocusListeners() "getFocusListeners"), [removeHierarchyListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#removeHierarchyListener(java.awt.event.HierarchyListener) "removeHierarchyListener"), [getHierarchyListeners](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getHierarchyListeners() "getHierarchyListeners"), [removeHierarchyBoundsListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#removeHierarchyBoundsListener(java.awt.event.HierarchyBoundsListener) "removeHierarchyBoundsListener"), [getHierarchyBoundsListeners](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getHierarchyBoundsListeners() "getHierarchyBoundsListeners"), [removeKeyListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#removeKeyListener(java.awt.event.KeyListener) "removeKeyListener"), [getKeyListeners](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getKeyListeners() "getKeyListeners"), [removeMouseListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#removeMouseListener(java.awt.event.MouseListener) "removeMouseListener"), [getMouseListeners](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getMouseListeners() "getMouseListeners"), [removeMouseMotionListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#removeMouseMotionListener(java.awt.event.MouseMotionListener) "removeMouseMotionListener"), [getMouseMotionListeners](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getMouseMotionListeners() "getMouseMotionListeners"), [removeMouseWheelListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#removeMouseWheelListener(java.awt.event.MouseWheelListener) "removeMouseWheelListener"), [getMouseWheelListeners](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getMouseWheelListeners() "getMouseWheelListeners"), [removeInputMethodListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#removeInputMethodListener(java.awt.event.InputMethodListener) "removeInputMethodListener"), [getInputMethodListeners](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getInputMethodListeners() "getInputMethodListeners"), [getInputMethodRequests](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getInputMethodRequests() "getInputMethodRequests"), [setFocusable](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setFocusable(boolean) "setFocusable"), [setFocusTraversalKeysEnabled](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setFocusTraversalKeysEnabled(boolean) "setFocusTraversalKeysEnabled"), [getFocusTraversalKeysEnabled](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getFocusTraversalKeysEnabled() "getFocusTraversalKeysEnabled"), [transferFocusUpCycle](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#transferFocusUpCycle() "transferFocusUpCycle"), [getComponentOrientation](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getComponentOrientation() "getComponentOrientation"), [setMixingCutoutShape](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setMixingCutoutShape(java.awt.Shape) "setMixingCutoutShape"), [setLocation](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setLocation(java.awt.Point) "setLocation"), [setLocation](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setLocation(int,%20int) "setLocation"), [getPropertyChangeListeners](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getPropertyChangeListeners(java.lang.String) "getPropertyChangeListeners"), [getPropertyChangeListeners](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getPropertyChangeListeners() "getPropertyChangeListeners"), [isShowing](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#isShowing() "isShowing"), [getGraphicsConfiguration](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getGraphicsConfiguration() "getGraphicsConfiguration"), [isFocusable](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#isFocusable() "isFocusable"), [isFocusOwner](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#isFocusOwner() "isFocusOwner"), [transferFocus](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#transferFocus() "transferFocus"), [postEvent](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#postEvent(java.awt.Event) "postEvent"), [transferFocusBackward](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#transferFocusBackward() "transferFocusBackward"), [getMousePosition](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getMousePosition() "getMousePosition"), [getToolkit](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getToolkit() "getToolkit"), [getLocationOnScreen](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getLocationOnScreen() "getLocationOnScreen"), [getInputContext](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getInputContext() "getInputContext"), [show](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#show(boolean) "show"), [show](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#show() "show"), [getColorModel](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getColorModel() "getColorModel"), [createImage](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#createImage(int,%20int) "createImage"), [createImage](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#createImage(java.awt.image.ImageProducer) "createImage"), [createVolatileImage](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#createVolatileImage(int,%20int,%20java.awt.ImageCapabilities) "createVolatileImage"), [createVolatileImage](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#createVolatileImage(int,%20int) "createVolatileImage"), [prepareImage](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#prepareImage(java.awt.Image,%20int,%20int,%20java.awt.image.ImageObserver) "prepareImage"), [prepareImage](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#prepareImage(java.awt.Image,%20java.awt.image.ImageObserver) "prepareImage"), [checkImage](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#checkImage(java.awt.Image,%20int,%20int,%20java.awt.image.ImageObserver) "checkImage"), [checkImage](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#checkImage(java.awt.Image,%20java.awt.image.ImageObserver) "checkImage"), [inside](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#inside(int,%20int) "inside"), [firePropertyChange](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#firePropertyChange(java.lang.String,%20byte,%20byte) "firePropertyChange"), [firePropertyChange](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#firePropertyChange(java.lang.String,%20double,%20double) "firePropertyChange"), [firePropertyChange](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#firePropertyChange(java.lang.String,%20float,%20float) "firePropertyChange"), [firePropertyChange](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#firePropertyChange(java.lang.String,%20long,%20long) "firePropertyChange"), [firePropertyChange](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#firePropertyChange(java.lang.String,%20short,%20short) "firePropertyChange"), [removePropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#removePropertyChangeListener(java.lang.String,%20java.beans.PropertyChangeListener) "removePropertyChangeListener"), [removePropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#removePropertyChangeListener(java.beans.PropertyChangeListener) "removePropertyChangeListener"), [repaint](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#repaint(int,%20int,%20int,%20int) "repaint"), [repaint](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#repaint() "repaint"), [repaint](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#repaint(long) "repaint"), [getForeground](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getForeground() "getForeground"), [getFont](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getFont() "getFont"), [getTreeLock](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getTreeLock() "getTreeLock"), [getFocusCycleRootAncestor](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getFocusCycleRootAncestor() "getFocusCycleRootAncestor"), [isDisplayable](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#isDisplayable() "isDisplayable"), [nextFocus](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#nextFocus() "nextFocus"), [requestFocus](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#requestFocus(java.awt.event.FocusEvent%24Cause) "requestFocus"), [requestFocusInWindow](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#requestFocusInWindow(java.awt.event.FocusEvent%24Cause) "requestFocusInWindow"), [isPreferredSizeSet](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#isPreferredSizeSet() "isPreferredSizeSet"), [isMaximumSizeSet](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#isMaximumSizeSet() "isMaximumSizeSet"), [isMinimumSizeSet](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#isMinimumSizeSet() "isMinimumSizeSet"), [getBackground](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getBackground() "getBackground"), [isLightweight](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#isLightweight() "isLightweight"), [setBounds](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setBounds(int,%20int,%20int,%20int) "setBounds"), [setBounds](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#setBounds(java.awt.Rectangle) "setBounds"), [handleEvent](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#handleEvent(java.awt.Event) "handleEvent"), [isVisible](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#isVisible() "isVisible"), [wait](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#equals(java.lang.Object) "equals"), [hashCode](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/javax/swing/JPanel.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public TableLayout() Method Detail ------------- ### public void addCell([TableLayoutCell](tablelayoutcell) cell) Adds a new cell to the current grid Parameters: `cell` - the td component ### public int getCellpadding() ### public int nextRowIndex() Creates a new row index for child tr tags Returns: nextRowIndex the row number ### public void setCellpadding(int cellpadding)	programming_docs
groovy [Java] Class ListWrapperListModel<E> [Java] Class ListWrapperListModel<E> ==================================== * groovy.swing.impl.ListWrapperListModel ``` public class ListWrapperListModel<E> extends [AbstractListModel](../../../abstractlistmodel) ``` A `ListModel` implementation that's backed by a live `List`. Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[ListWrapperListModel](#ListWrapperListModel(List))([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<E> delegateList)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public void` \| `[add](#add(int,%20E))(int i, E e)` \| \| \| `public boolean` \| `[add](#add(E))(E e)` \| \| \| `public boolean` \| `[addAll](#addAll(Collection))([Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection")<? extends E> es)` \| \| \| `public boolean` \| `[addAll](#addAll(int,%20Collection))(int i, [Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection")<? extends E> es)` \| \| \| `public void` \| `[clear](#clear())()` \| \| \| `public boolean` \| `[contains](#contains(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o)` \| \| \| `public boolean` \| `[containsAll](#containsAll(Collection))([Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection")<?> objects)` \| \| \| `public E` \| `[get](#get(int))(int i)` \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<E>` \| `[getDelegateList](#getDelegateList())()` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getElementAt](#getElementAt(int))(int i)` \| \| \| `public int` \| `[getSize](#getSize())()` \| \| \| `public int` \| `[indexOf](#indexOf(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o)` \| \| \| `public boolean` \| `[isEmpty](#isEmpty())()` \| \| \| `public [Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html "Iterator")<E>` \| `[iterator](#iterator())()` \| \| \| `public int` \| `[lastIndexOf](#lastIndexOf(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o)` \| \| \| `public [ListIterator](https://docs.oracle.com/javase/8/docs/api/java/util/ListIterator.html "ListIterator")<E>` \| `[listIterator](#listIterator())()` \| \| \| `public [ListIterator](https://docs.oracle.com/javase/8/docs/api/java/util/ListIterator.html "ListIterator")<E>` \| `[listIterator](#listIterator(int))(int i)` \| \| \| `public E` \| `[remove](#remove(int))(int i)` \| \| \| `public boolean` \| `[remove](#remove(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o)` \| \| \| `public void` \| `[removeRange](#removeRange(int,%20int))(int fromIndex, int toIndex)` \| \| \| `public E` \| `[set](#set(int,%20E))(int i, E e)` \| \| `<T>` \| `public T[]` \| `[toArray](#toArray(T))(T[] ts)` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[]` \| `[toArray](#toArray())()` \| Constructor Detail ------------------ ### public ListWrapperListModel([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<E> delegateList) Method Detail ------------- ### public void add(int i, E e) ### public boolean add(E e) ### public boolean addAll([Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection")<? extends E> es) ### public boolean addAll(int i, [Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection")<? extends E> es) ### public void clear() ### public boolean contains([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o) ### public boolean containsAll([Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html "Collection")<?> objects) ### public E get(int i) ### public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<E> getDelegateList() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getElementAt(int i) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public int getSize() ### public int indexOf([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o) ### public boolean isEmpty() ### public [Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html "Iterator")<E> iterator() ### public int lastIndexOf([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o) ### public [ListIterator](https://docs.oracle.com/javase/8/docs/api/java/util/ListIterator.html "ListIterator")<E> listIterator() ### public [ListIterator](https://docs.oracle.com/javase/8/docs/api/java/util/ListIterator.html "ListIterator")<E> listIterator(int i) ### public E remove(int i) ### public boolean remove([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o) ### public void removeRange(int fromIndex, int toIndex) ### public E set(int i, E e) ### <T> public T[] toArray(T[] ts) ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] toArray() groovy [Java] Class ClosureRenderer [Java] Class ClosureRenderer ============================ * groovy.swing.impl.ClosureRenderer All Implemented Interfaces and Traits: [ListCellRenderer](../../../listcellrenderer), [TableCellRenderer](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableCellRenderer.html "TableCellRenderer"), [TreeCellRenderer](https://docs.oracle.com/javase/8/docs/api/javax/swing/tree/TreeCellRenderer.html "TreeCellRenderer") ``` public class ClosureRenderer extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") implements [ListCellRenderer](../../../listcellrenderer), [TableCellRenderer](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableCellRenderer.html "TableCellRenderer"), [TreeCellRenderer](https://docs.oracle.com/javase/8/docs/api/javax/swing/tree/TreeCellRenderer.html "TreeCellRenderer") ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[ClosureRenderer](#ClosureRenderer())()` \| \| `[ClosureRenderer](#ClosureRenderer(groovy.lang.Closure))([Closure](../../lang/closure) c)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")` \| `[getChildren](#getChildren())()` \| \| \| `public int` \| `[getColumn](#getColumn())()` \| \| \| `public [JList](https://docs.oracle.com/javase/8/docs/api/javax/swing/JList.html "JList")` \| `[getList](#getList())()` \| \| \| `public [Component](https://docs.oracle.com/javase/8/docs/api/java/awt/Component.html "Component")` \| `[getListCellRendererComponent](#getListCellRendererComponent(javax.swing.JList,%20java.lang.Object,%20int,%20boolean,%20boolean))([JList](https://docs.oracle.com/javase/8/docs/api/javax/swing/JList.html "JList") list, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, int index, boolean isSelected, boolean cellHasFocus)` \| \| \| `public int` \| `[getRow](#getRow())()` \| \| \| `public [JTable](https://docs.oracle.com/javase/8/docs/api/javax/swing/JTable.html "JTable")` \| `[getTable](#getTable())()` \| \| \| `public [Component](https://docs.oracle.com/javase/8/docs/api/java/awt/Component.html "Component")` \| `[getTableCellRendererComponent](#getTableCellRendererComponent(javax.swing.JTable,%20java.lang.Object,%20boolean,%20boolean,%20int,%20int))([JTable](https://docs.oracle.com/javase/8/docs/api/javax/swing/JTable.html "JTable") table, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, boolean isSelected, boolean hasFocus, int row, int column)` \| \| \| `public [JTree](../../../jtree)` \| `[getTree](#getTree())()` \| \| \| `public [Component](https://docs.oracle.com/javase/8/docs/api/java/awt/Component.html "Component")` \| `[getTreeCellRendererComponent](#getTreeCellRendererComponent(JTree,%20java.lang.Object,%20boolean,%20boolean,%20boolean,%20int,%20boolean))([JTree](../../../jtree) tree, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, boolean selected, boolean expanded, boolean leaf, int row, boolean hasFocus)` \| \| \| `public [Closure](../../lang/closure)` \| `[getUpdate](#getUpdate())()` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getValue](#getValue())()` \| \| \| `public boolean` \| `[isDefaultRenderer](#isDefaultRenderer())()` \| \| \| `public boolean` \| `[isExpanded](#isExpanded())()` \| \| \| `public boolean` \| `[isFocused](#isFocused())()` \| \| \| `public boolean` \| `[isLeaf](#isLeaf())()` \| \| \| `public boolean` \| `[isSelected](#isSelected())()` \| \| \| `public boolean` \| `[isTableHeader](#isTableHeader())()` \| \| \| `public void` \| `[setTableHeader](#setTableHeader(boolean))(boolean tableHeader)` \| \| \| `public void` \| `[setUpdate](#setUpdate(groovy.lang.Closure))([Closure](../../lang/closure) update)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public ClosureRenderer() ### public ClosureRenderer([Closure](../../lang/closure) c) Method Detail ------------- ### public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") getChildren() ### public int getColumn() ### public [JList](https://docs.oracle.com/javase/8/docs/api/javax/swing/JList.html "JList") getList() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Component](https://docs.oracle.com/javase/8/docs/api/java/awt/Component.html "Component") getListCellRendererComponent([JList](https://docs.oracle.com/javase/8/docs/api/javax/swing/JList.html "JList") list, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, int index, boolean isSelected, boolean cellHasFocus) ### public int getRow() ### public [JTable](https://docs.oracle.com/javase/8/docs/api/javax/swing/JTable.html "JTable") getTable() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Component](https://docs.oracle.com/javase/8/docs/api/java/awt/Component.html "Component") getTableCellRendererComponent([JTable](https://docs.oracle.com/javase/8/docs/api/javax/swing/JTable.html "JTable") table, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, boolean isSelected, boolean hasFocus, int row, int column) ### public [JTree](../../../jtree) getTree() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Component](https://docs.oracle.com/javase/8/docs/api/java/awt/Component.html "Component") getTreeCellRendererComponent([JTree](../../../jtree) tree, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, boolean selected, boolean expanded, boolean leaf, int row, boolean hasFocus) ### public [Closure](../../lang/closure) getUpdate() ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getValue() ### public boolean isDefaultRenderer() ### public boolean isExpanded() ### public boolean isFocused() ### public boolean isLeaf() ### public boolean isSelected() ### public boolean isTableHeader() ### public void setTableHeader(boolean tableHeader) ### public void setUpdate([Closure](../../lang/closure) update) groovy [Java] Class TableLayoutCell [Java] Class TableLayoutCell ============================ * groovy.swing.impl.TableLayoutCell ``` public class TableLayoutCell extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Represents a cell in a table layout. Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `protected static [Logger](https://docs.oracle.com/javase/8/docs/api/java/util/logging/Logger.html "Logger")` \| `[LOG](#LOG)` \| \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[TableLayoutCell](#TableLayoutCell(groovy.swing.impl.TableLayoutRow))([TableLayoutRow](tablelayoutrow) parent)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public void` \| `[addComponent](#addComponent(java.awt.Component))([Component](https://docs.oracle.com/javase/8/docs/api/java/awt/Component.html "Component") component)` \| \| \| `protected [GridBagConstraints](../../../gridbagconstraints)` \| `[createConstraints](#createConstraints())()` \| \| \| `protected int` \| `[getAnchor](#getAnchor())()` Returns: the GridBagConstraints enumeration for anchor \| \| \| `public int` \| `[getColspan](#getColspan())()` \| \| \| `public [Component](https://docs.oracle.com/javase/8/docs/api/java/awt/Component.html "Component")` \| `[getComponent](#getComponent())()` \| \| \| `public [GridBagConstraints](../../../gridbagconstraints)` \| `[getConstraints](#getConstraints())()` Returns: the constraints of this cell \| \| \| `public int` \| `[getRowspan](#getRowspan())()` \| \| \| `public boolean` \| `[isColfill](#isColfill())()`Returns the colfill. \| \| \| `public boolean` \| `[isRowfill](#isRowfill())()`Returns the rowfill. \| \| \| `public void` \| `[setAlign](#setAlign(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") align)`Sets the horizontal alignment to a case insensitive value of {LEFT, CENTER, RIGHT} \| \| \| `public void` \| `[setColfill](#setColfill(boolean))(boolean colfill)`Sets whether or not this column should allow its component to stretch to fill the space available \| \| \| `public void` \| `[setColspan](#setColspan(int))(int colspan)`Sets the number of columns that this cell should span. \| \| \| `public void` \| `[setRowfill](#setRowfill(boolean))(boolean rowfill)`Sets whether or not this row should allow its component to stretch to fill the space available \| \| \| `public void` \| `[setRowspan](#setRowspan(int))(int rowspan)`Sets the number of rows that this cell should span. \| \| \| `public void` \| `[setValign](#setValign(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") valign)`Sets the vertical alignment to a case insensitive value of {TOP, MIDDLE, BOTTOM} \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Field Detail ------------ ### protected static final [Logger](https://docs.oracle.com/javase/8/docs/api/java/util/logging/Logger.html "Logger") LOG Constructor Detail ------------------ ### public TableLayoutCell([TableLayoutRow](tablelayoutrow) parent) Method Detail ------------- ### public void addComponent([Component](https://docs.oracle.com/javase/8/docs/api/java/awt/Component.html "Component") component) ### protected [GridBagConstraints](../../../gridbagconstraints) createConstraints() ### protected int getAnchor() Returns: the GridBagConstraints enumeration for anchor ### public int getColspan() ### public [Component](https://docs.oracle.com/javase/8/docs/api/java/awt/Component.html "Component") getComponent() ### public [GridBagConstraints](../../../gridbagconstraints) getConstraints() Returns: the constraints of this cell ### public int getRowspan() ### public boolean isColfill() Returns the colfill. Returns: boolean ### public boolean isRowfill() Returns the rowfill. Returns: boolean ### public void setAlign([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") align) Sets the horizontal alignment to a case insensitive value of {LEFT, CENTER, RIGHT} Parameters: `align` - one of 'left', 'center', or 'right' ### public void setColfill(boolean colfill) Sets whether or not this column should allow its component to stretch to fill the space available Parameters: `colfill` - The default is false ### public void setColspan(int colspan) Sets the number of columns that this cell should span. The default value is 1 Parameters: `colspan` - The default is 1 ### public void setRowfill(boolean rowfill) Sets whether or not this row should allow its component to stretch to fill the space available Parameters: `rowfill` - The default is false ### public void setRowspan(int rowspan) Sets the number of rows that this cell should span. The default value is 1 Parameters: `rowspan` - The default is 1 ### public void setValign([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") valign) Sets the vertical alignment to a case insensitive value of {TOP, MIDDLE, BOTTOM} Parameters: `valign` - one of 'top', 'middle', 'bottom' groovy [Groovy] Class ClosureCellEditor [Groovy] Class ClosureCellEditor ================================ * groovy.swing.impl.ClosureCellEditor All Implemented Interfaces and Traits: [TableCellEditor](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableCellEditor.html "TableCellEditor"), [TreeCellEditor](https://docs.oracle.com/javase/8/docs/api/javax/swing/tree/TreeCellEditor.html "TreeCellEditor") ``` class ClosureCellEditor extends [AbstractCellEditor](https://docs.oracle.com/javase/8/docs/api/javax/swing/AbstractCellEditor.html "AbstractCellEditor") implements [TableCellEditor](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableCellEditor.html "TableCellEditor"), [TreeCellEditor](https://docs.oracle.com/javase/8/docs/api/javax/swing/tree/TreeCellEditor.html "TreeCellEditor") ``` Properties Summary ------------------ Properties \| Type \| Name and description \| \| `[Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Closure](../../lang/closure "Closure")>` \| `[callbacks](#callbacks)` \| \| `[List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")` \| `[children](#children)` \| \| `int` \| `[column](#column)` \| \| `boolean` \| `[defaultEditor](#defaultEditor)` \| \| `[Closure](../../lang/closure "Closure")` \| `[editorValue](#editorValue)` \| \| `boolean` \| `[expanded](#expanded)` \| \| `boolean` \| `[leaf](#leaf)` \| \| `[Closure](../../lang/closure "Closure")` \| `[prepareEditor](#prepareEditor)` \| \| `int` \| `[row](#row)` \| \| `boolean` \| `[selected](#selected)` \| \| `[JTable](https://docs.oracle.com/javase/8/docs/api/javax/swing/JTable.html "JTable")` \| `[table](#table)` \| \| `[JTree](../../../jtree)` \| `[tree](#tree)` \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[value](#value)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[ClosureCellEditor](#ClosureCellEditor(groovy.lang.Closure,%20Map))([Closure](../../lang/closure) c, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Closure](../../lang/closure "Closure")> callbacks)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getCellEditorValue](#getCellEditorValue())()` \| \| \| `[Component](https://docs.oracle.com/javase/8/docs/api/java/awt/Component.html "Component")` \| `[getTableCellEditorComponent](#getTableCellEditorComponent(javax.swing.JTable,%20java.lang.Object,%20boolean,%20int,%20int))([JTable](https://docs.oracle.com/javase/8/docs/api/javax/swing/JTable.html "JTable") table, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, boolean isSelected, int row, int column)` \| \| \| `[Component](https://docs.oracle.com/javase/8/docs/api/java/awt/Component.html "Component")` \| `[getTreeCellEditorComponent](#getTreeCellEditorComponent(JTree,%20java.lang.Object,%20boolean,%20boolean,%20boolean,%20int))([JTree](../../../jtree) tree, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, boolean isSelected, boolean expanded, boolean leaf, int row)` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[invokeMethod](#invokeMethod(java.lang.String,%20java.lang.Object))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args)` \| \| \| `void` \| `[setEditorValue](#setEditorValue(groovy.lang.Closure))([Closure](../../lang/closure) editorValue)` \| \| \| `void` \| `[setPrepareEditor](#setPrepareEditor(groovy.lang.Closure))([Closure](../../lang/closure) prepareEditor)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractCellEditor](https://docs.oracle.com/javase/8/docs/api/javax/swing/AbstractCellEditor.html "AbstractCellEditor")` \| `[isCellEditable](https://docs.oracle.com/javase/8/docs/api/javax/swing/AbstractCellEditor.html#isCellEditable(java.util.EventObject) "isCellEditable"), [stopCellEditing](https://docs.oracle.com/javase/8/docs/api/javax/swing/AbstractCellEditor.html#stopCellEditing() "stopCellEditing"), [addCellEditorListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/AbstractCellEditor.html#addCellEditorListener(javax.swing.event.CellEditorListener) "addCellEditorListener"), [cancelCellEditing](https://docs.oracle.com/javase/8/docs/api/javax/swing/AbstractCellEditor.html#cancelCellEditing() "cancelCellEditing"), [removeCellEditorListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/AbstractCellEditor.html#removeCellEditorListener(javax.swing.event.CellEditorListener) "removeCellEditorListener"), [shouldSelectCell](https://docs.oracle.com/javase/8/docs/api/javax/swing/AbstractCellEditor.html#shouldSelectCell(java.util.EventObject) "shouldSelectCell"), [getCellEditorListeners](https://docs.oracle.com/javase/8/docs/api/javax/swing/AbstractCellEditor.html#getCellEditorListeners() "getCellEditorListeners"), [wait](https://docs.oracle.com/javase/8/docs/api/javax/swing/AbstractCellEditor.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/javax/swing/AbstractCellEditor.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/javax/swing/AbstractCellEditor.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/javax/swing/AbstractCellEditor.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/javax/swing/AbstractCellEditor.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/javax/swing/AbstractCellEditor.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/javax/swing/AbstractCellEditor.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/javax/swing/AbstractCellEditor.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/javax/swing/AbstractCellEditor.html#notifyAll() "notifyAll"), [getCellEditorValue](https://docs.oracle.com/javase/8/docs/api/javax/swing/AbstractCellEditor.html#getCellEditorValue() "getCellEditorValue")` \| Property Detail --------------- ### [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Closure](../../lang/closure "Closure")> callbacks ### [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") children ### int column ### boolean defaultEditor ### [Closure](../../lang/closure "Closure") editorValue ### boolean expanded ### boolean leaf ### [Closure](../../lang/closure "Closure") prepareEditor ### int row ### boolean selected ### [JTable](https://docs.oracle.com/javase/8/docs/api/javax/swing/JTable.html "JTable") table ### [JTree](../../../jtree) tree ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value Constructor Detail ------------------ ### ClosureCellEditor([Closure](../../lang/closure) c, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Closure](../../lang/closure "Closure")> callbacks) Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getCellEditorValue() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") [Component](https://docs.oracle.com/javase/8/docs/api/java/awt/Component.html "Component") getTableCellEditorComponent([JTable](https://docs.oracle.com/javase/8/docs/api/javax/swing/JTable.html "JTable") table, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, boolean isSelected, int row, int column) ### [Component](https://docs.oracle.com/javase/8/docs/api/java/awt/Component.html "Component") getTreeCellEditorComponent([JTree](../../../jtree) tree, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, boolean isSelected, boolean expanded, boolean leaf, int row) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") invokeMethod([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args) ### void setEditorValue([Closure](../../lang/closure) editorValue) ### void setPrepareEditor([Closure](../../lang/closure) prepareEditor)	programming_docs
groovy [Groovy] Class JListProperties.1 [Groovy] Class JListProperties.1 ================================ * groovy.swing.binding.JListProperties.1 ``` class JListProperties.1 extends [TriggerBinding](../../../org/apache/groovy/swing/binding/triggerbinding) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[JListProperties.1](#JListProperties.1())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[FullBinding](../../../org/apache/groovy/swing/binding/fullbinding)` \| `[createBinding](#createBinding(org.apache.groovy.swing.binding.SourceBinding,%20org.apache.groovy.swing.binding.TargetBinding))([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `interface [TriggerBinding](../../../org/apache/groovy/swing/binding/triggerbinding)` \| `[createBinding](../../../org/apache/groovy/swing/binding/triggerbinding#createBinding(org.apache.groovy.swing.binding.SourceBinding,%20org.apache.groovy.swing.binding.TargetBinding))` \| Constructor Detail ------------------ ### JListProperties.1() Method Detail ------------- ### [FullBinding](../../../org/apache/groovy/swing/binding/fullbinding) createBinding([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target) groovy [Groovy] Class JListMetaMethods [Groovy] Class JListMetaMethods =============================== * groovy.swing.binding.JListMetaMethods ``` class JListMetaMethods extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Since: 1.7.5 Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[JListMetaMethods](#JListMetaMethods())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `static void` \| `[enhanceMetaClass](#enhanceMetaClass(javax.swing.JList))([JList](https://docs.oracle.com/javase/8/docs/api/javax/swing/JList.html "JList") list)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### JListMetaMethods() Method Detail ------------- ### static void enhanceMetaClass([JList](https://docs.oracle.com/javase/8/docs/api/javax/swing/JList.html "JList") list) groovy [Groovy] Class JTableMetaMethods [Groovy] Class JTableMetaMethods ================================ * groovy.swing.binding.JTableMetaMethods ``` class JTableMetaMethods extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[JTableMetaMethods](#JTableMetaMethods())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `static void` \| `[enhanceMetaClass](#enhanceMetaClass(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") table)` \| \| \| `static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getElement](#getElement(javax.swing.JTable,%20int))([JTable](https://docs.oracle.com/javase/8/docs/api/javax/swing/JTable.html "JTable") table, int row)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### JTableMetaMethods() Method Detail ------------- ### static void enhanceMetaClass([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") table) ### static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getElement([JTable](https://docs.oracle.com/javase/8/docs/api/javax/swing/JTable.html "JTable") table, int row) groovy [Groovy] Class JComboBoxMetaMethods [Groovy] Class JComboBoxMetaMethods =================================== * groovy.swing.binding.JComboBoxMetaMethods ``` class JComboBoxMetaMethods extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[JComboBoxMetaMethods](#JComboBoxMetaMethods())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `static void` \| `[enhanceMetaClass](#enhanceMetaClass(javax.swing.JComboBox))([JComboBox](https://docs.oracle.com/javase/8/docs/api/javax/swing/JComboBox.html "JComboBox") comboBox)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### JComboBoxMetaMethods() Method Detail ------------- ### static void enhanceMetaClass([JComboBox](https://docs.oracle.com/javase/8/docs/api/javax/swing/JComboBox.html "JComboBox") comboBox) groovy [Java] Class JSpinnerProperties [Java] Class JSpinnerProperties =============================== * groovy.swing.binding.JSpinnerProperties ``` public class JSpinnerProperties extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Since: Groovy 1.6.4 Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [FullBinding](../../../org/apache/groovy/swing/binding/fullbinding)` \| `[createBinding](#createBinding(org.apache.groovy.swing.binding.SourceBinding,%20org.apache.groovy.swing.binding.TargetBinding))([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target)` \| \| \| `public static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [TriggerBinding](../../../org/apache/groovy/swing/binding/triggerbinding "TriggerBinding")>` \| `[getSyntheticProperties](#getSyntheticProperties())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [FullBinding](../../../org/apache/groovy/swing/binding/fullbinding) createBinding([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target) ### public static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [TriggerBinding](../../../org/apache/groovy/swing/binding/triggerbinding "TriggerBinding")> getSyntheticProperties() groovy [Java] Class JTextComponentProperties [Java] Class JTextComponentProperties ===================================== * groovy.swing.binding.JTextComponentProperties ``` public class JTextComponentProperties extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Since: Groovy 1.1 Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [FullBinding](../../../org/apache/groovy/swing/binding/fullbinding)` \| `[createBinding](#createBinding(org.apache.groovy.swing.binding.SourceBinding,%20org.apache.groovy.swing.binding.TargetBinding))([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target)` \| \| \| `public static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [TriggerBinding](../../../org/apache/groovy/swing/binding/triggerbinding "TriggerBinding")>` \| `[getSyntheticProperties](#getSyntheticProperties())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [FullBinding](../../../org/apache/groovy/swing/binding/fullbinding) createBinding([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target) ### public static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [TriggerBinding](../../../org/apache/groovy/swing/binding/triggerbinding "TriggerBinding")> getSyntheticProperties() groovy [Groovy] Class JListProperties [Groovy] Class JListProperties ============================== * groovy.swing.binding.JListProperties ``` class JListProperties extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Since: Groovy 1.7.5 Nested Class Summary -------------------- Nested classes \| Modifiers \| Name \| Description \| \| `class` \| `[JListProperties.1](jlistproperties.1)` \| \| \| `class` \| `[JListProperties.2](jlistproperties.2)` \| \| \| `class` \| `[JListProperties.3](jlistproperties.3)` \| \| \| `class` \| `[JListProperties.4](jlistproperties.4)` \| \| \| `class` \| `[JListProperties.5](jlistproperties.5)` \| \| \| `class` \| `[JListProperties.6](jlistproperties.6)` \| \| \| `class` \| `[JListProperties.7](jlistproperties.7)` \| \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[JListProperties](#JListProperties())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), TriggerBinding>` \| `[getSyntheticProperties](#getSyntheticProperties())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### JListProperties() Method Detail ------------- ### static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), TriggerBinding> getSyntheticProperties() groovy [Groovy] Class JListProperties.7 [Groovy] Class JListProperties.7 ================================ * groovy.swing.binding.JListProperties.7 ``` class JListProperties.7 extends [TriggerBinding](../../../org/apache/groovy/swing/binding/triggerbinding) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[JListProperties.7](#JListProperties.7())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[FullBinding](../../../org/apache/groovy/swing/binding/fullbinding)` \| `[createBinding](#createBinding(org.apache.groovy.swing.binding.SourceBinding,%20org.apache.groovy.swing.binding.TargetBinding))([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `interface [TriggerBinding](../../../org/apache/groovy/swing/binding/triggerbinding)` \| `[createBinding](../../../org/apache/groovy/swing/binding/triggerbinding#createBinding(org.apache.groovy.swing.binding.SourceBinding,%20org.apache.groovy.swing.binding.TargetBinding))` \| Constructor Detail ------------------ ### JListProperties.7() Method Detail ------------- ### [FullBinding](../../../org/apache/groovy/swing/binding/fullbinding) createBinding([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target) groovy [Groovy] Class JListProperties.6 [Groovy] Class JListProperties.6 ================================ * groovy.swing.binding.JListProperties.6 ``` class JListProperties.6 extends [TriggerBinding](../../../org/apache/groovy/swing/binding/triggerbinding) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[JListProperties.6](#JListProperties.6())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[FullBinding](../../../org/apache/groovy/swing/binding/fullbinding)` \| `[createBinding](#createBinding(org.apache.groovy.swing.binding.SourceBinding,%20org.apache.groovy.swing.binding.TargetBinding))([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `interface [TriggerBinding](../../../org/apache/groovy/swing/binding/triggerbinding)` \| `[createBinding](../../../org/apache/groovy/swing/binding/triggerbinding#createBinding(org.apache.groovy.swing.binding.SourceBinding,%20org.apache.groovy.swing.binding.TargetBinding))` \| Constructor Detail ------------------ ### JListProperties.6() Method Detail ------------- ### [FullBinding](../../../org/apache/groovy/swing/binding/fullbinding) createBinding([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target)	programming_docs
groovy [Groovy] Class AbstractSyntheticMetaMethods [Groovy] Class AbstractSyntheticMetaMethods =========================================== * groovy.swing.binding.AbstractSyntheticMetaMethods ``` class AbstractSyntheticMetaMethods extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[AbstractSyntheticMetaMethods](#AbstractSyntheticMetaMethods())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `static void` \| `[enhance](#enhance(java.lang.Object,%20java.util.Map))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") enhancedMethods)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### AbstractSyntheticMetaMethods() Method Detail ------------- ### static void enhance([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") enhancedMethods) groovy [Groovy] Class JListProperties.5 [Groovy] Class JListProperties.5 ================================ * groovy.swing.binding.JListProperties.5 ``` class JListProperties.5 extends [TriggerBinding](../../../org/apache/groovy/swing/binding/triggerbinding) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[JListProperties.5](#JListProperties.5())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[FullBinding](../../../org/apache/groovy/swing/binding/fullbinding)` \| `[createBinding](#createBinding(org.apache.groovy.swing.binding.SourceBinding,%20org.apache.groovy.swing.binding.TargetBinding))([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `interface [TriggerBinding](../../../org/apache/groovy/swing/binding/triggerbinding)` \| `[createBinding](../../../org/apache/groovy/swing/binding/triggerbinding#createBinding(org.apache.groovy.swing.binding.SourceBinding,%20org.apache.groovy.swing.binding.TargetBinding))` \| Constructor Detail ------------------ ### JListProperties.5() Method Detail ------------- ### [FullBinding](../../../org/apache/groovy/swing/binding/fullbinding) createBinding([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target) groovy [Java] Class JScrollBarProperties [Java] Class JScrollBarProperties ================================= * groovy.swing.binding.JScrollBarProperties ``` public class JScrollBarProperties extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Since: Groovy 1.1 Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [FullBinding](../../../org/apache/groovy/swing/binding/fullbinding)` \| `[createBinding](#createBinding(org.apache.groovy.swing.binding.SourceBinding,%20org.apache.groovy.swing.binding.TargetBinding))([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target)` \| \| \| `public static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [TriggerBinding](../../../org/apache/groovy/swing/binding/triggerbinding "TriggerBinding")>` \| `[getSyntheticProperties](#getSyntheticProperties())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [FullBinding](../../../org/apache/groovy/swing/binding/fullbinding) createBinding([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target) ### public static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [TriggerBinding](../../../org/apache/groovy/swing/binding/triggerbinding "TriggerBinding")> getSyntheticProperties() groovy [Java] Class JSliderProperties [Java] Class JSliderProperties ============================== * groovy.swing.binding.JSliderProperties ``` public class JSliderProperties extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Since: Groovy 1.1 Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [FullBinding](../../../org/apache/groovy/swing/binding/fullbinding)` \| `[createBinding](#createBinding(org.apache.groovy.swing.binding.SourceBinding,%20org.apache.groovy.swing.binding.TargetBinding))([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target)` \| \| \| `public static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [TriggerBinding](../../../org/apache/groovy/swing/binding/triggerbinding "TriggerBinding")>` \| `[getSyntheticProperties](#getSyntheticProperties())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [FullBinding](../../../org/apache/groovy/swing/binding/fullbinding) createBinding([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target) ### public static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [TriggerBinding](../../../org/apache/groovy/swing/binding/triggerbinding "TriggerBinding")> getSyntheticProperties() groovy [Java] Class AbstractButtonProperties [Java] Class AbstractButtonProperties ===================================== * groovy.swing.binding.AbstractButtonProperties ``` public class AbstractButtonProperties extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Since: Groovy 1.1 Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [FullBinding](../../../org/apache/groovy/swing/binding/fullbinding)` \| `[createBinding](#createBinding(org.apache.groovy.swing.binding.SourceBinding,%20org.apache.groovy.swing.binding.TargetBinding))([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target)` \| \| \| `public static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [TriggerBinding](../../../org/apache/groovy/swing/binding/triggerbinding "TriggerBinding")>` \| `[getSyntheticProperties](#getSyntheticProperties())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [FullBinding](../../../org/apache/groovy/swing/binding/fullbinding) createBinding([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target) ### public static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [TriggerBinding](../../../org/apache/groovy/swing/binding/triggerbinding "TriggerBinding")> getSyntheticProperties() groovy [Groovy] Class JListProperties.4 [Groovy] Class JListProperties.4 ================================ * groovy.swing.binding.JListProperties.4 ``` class JListProperties.4 extends [TriggerBinding](../../../org/apache/groovy/swing/binding/triggerbinding) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[JListProperties.4](#JListProperties.4())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[FullBinding](../../../org/apache/groovy/swing/binding/fullbinding)` \| `[createBinding](#createBinding(org.apache.groovy.swing.binding.SourceBinding,%20org.apache.groovy.swing.binding.TargetBinding))([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `interface [TriggerBinding](../../../org/apache/groovy/swing/binding/triggerbinding)` \| `[createBinding](../../../org/apache/groovy/swing/binding/triggerbinding#createBinding(org.apache.groovy.swing.binding.SourceBinding,%20org.apache.groovy.swing.binding.TargetBinding))` \| Constructor Detail ------------------ ### JListProperties.4() Method Detail ------------- ### [FullBinding](../../../org/apache/groovy/swing/binding/fullbinding) createBinding([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target) groovy [Groovy] Class JListProperties.3 [Groovy] Class JListProperties.3 ================================ * groovy.swing.binding.JListProperties.3 ``` class JListProperties.3 extends [TriggerBinding](../../../org/apache/groovy/swing/binding/triggerbinding) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[JListProperties.3](#JListProperties.3())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[FullBinding](../../../org/apache/groovy/swing/binding/fullbinding)` \| `[createBinding](#createBinding(org.apache.groovy.swing.binding.SourceBinding,%20org.apache.groovy.swing.binding.TargetBinding))([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `interface [TriggerBinding](../../../org/apache/groovy/swing/binding/triggerbinding)` \| `[createBinding](../../../org/apache/groovy/swing/binding/triggerbinding#createBinding(org.apache.groovy.swing.binding.SourceBinding,%20org.apache.groovy.swing.binding.TargetBinding))` \| Constructor Detail ------------------ ### JListProperties.3() Method Detail ------------- ### [FullBinding](../../../org/apache/groovy/swing/binding/fullbinding) createBinding([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target) groovy [Java] Class AbstractSyntheticBinding [Java] Class AbstractSyntheticBinding ===================================== * groovy.swing.binding.AbstractSyntheticBinding ``` public abstract class AbstractSyntheticBinding extends [AbstractFullBinding](../../../org/apache/groovy/swing/binding/abstractfullbinding) ``` Inherited fields \| Fields inherited from class \| Fields \| \| `class [AbstractFullBinding](../../../org/apache/groovy/swing/binding/abstractfullbinding)` \| `[converter](../../../org/apache/groovy/swing/binding/abstractfullbinding#converter), [reverseConverter](../../../org/apache/groovy/swing/binding/abstractfullbinding#reverseConverter), [sourceBinding](../../../org/apache/groovy/swing/binding/abstractfullbinding#sourceBinding), [targetBinding](../../../org/apache/groovy/swing/binding/abstractfullbinding#targetBinding), [validator](../../../org/apache/groovy/swing/binding/abstractfullbinding#validator)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[AbstractSyntheticBinding](#AbstractSyntheticBinding(org.apache.groovy.swing.binding.PropertyBinding,%20org.apache.groovy.swing.binding.TargetBinding,%20java.lang.Class,%20java.lang.String))([PropertyBinding](../../../org/apache/groovy/swing/binding/propertybinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") klass, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") propertyName)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public void` \| `[bind](#bind())()` \| \| \| `public void` \| `[rebind](#rebind())()` \| \| \| `public void` \| `[setSourceBinding](#setSourceBinding(org.apache.groovy.swing.binding.SourceBinding))([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source)` \| \| \| `public void` \| `[setTargetBinding](#setTargetBinding(org.apache.groovy.swing.binding.TargetBinding))([TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target)` \| \| \| `protected abstract void` \| `[syntheticBind](#syntheticBind())()` \| \| \| `protected abstract void` \| `[syntheticUnbind](#syntheticUnbind())()` \| \| \| `public void` \| `[unbind](#unbind())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractFullBinding](../../../org/apache/groovy/swing/binding/abstractfullbinding)` \| `[getConverter](../../../org/apache/groovy/swing/binding/abstractfullbinding#getConverter()), [getReverseConverter](../../../org/apache/groovy/swing/binding/abstractfullbinding#getReverseConverter()), [getSourceBinding](../../../org/apache/groovy/swing/binding/abstractfullbinding#getSourceBinding()), [getTargetBinding](../../../org/apache/groovy/swing/binding/abstractfullbinding#getTargetBinding()), [getValidator](../../../org/apache/groovy/swing/binding/abstractfullbinding#getValidator()), [reverseUpdate](../../../org/apache/groovy/swing/binding/abstractfullbinding#reverseUpdate()), [setConverter](../../../org/apache/groovy/swing/binding/abstractfullbinding#setConverter(groovy.lang.Closure)), [setReverseConverter](../../../org/apache/groovy/swing/binding/abstractfullbinding#setReverseConverter(groovy.lang.Closure)), [setSourceBinding](../../../org/apache/groovy/swing/binding/abstractfullbinding#setSourceBinding(org.apache.groovy.swing.binding.SourceBinding)), [setTargetBinding](../../../org/apache/groovy/swing/binding/abstractfullbinding#setTargetBinding(org.apache.groovy.swing.binding.TargetBinding)), [setValidator](../../../org/apache/groovy/swing/binding/abstractfullbinding#setValidator(groovy.lang.Closure)), [update](../../../org/apache/groovy/swing/binding/abstractfullbinding#update())` \| Constructor Detail ------------------ ### public AbstractSyntheticBinding([PropertyBinding](../../../org/apache/groovy/swing/binding/propertybinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") klass, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") propertyName) Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void bind() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void rebind() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void setSourceBinding([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void setTargetBinding([TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target) ### protected abstract void syntheticBind() ### protected abstract void syntheticUnbind() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void unbind()	programming_docs
groovy [Java] Class JComponentProperties [Java] Class JComponentProperties ================================= * groovy.swing.binding.JComponentProperties ``` public class JComponentProperties extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Since: Groovy 1.6 Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public void` \| `[componentHidden](#componentHidden(java.awt.event.ComponentEvent))([ComponentEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/ComponentEvent.html "ComponentEvent") event)` \| \| \| `public void` \| `[componentMoved](#componentMoved(java.awt.event.ComponentEvent))([ComponentEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/ComponentEvent.html "ComponentEvent") event)` \| \| \| `public void` \| `[componentMoved](#componentMoved(java.awt.event.ComponentEvent))([ComponentEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/ComponentEvent.html "ComponentEvent") event)` \| \| \| `public void` \| `[componentMoved](#componentMoved(java.awt.event.ComponentEvent))([ComponentEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/ComponentEvent.html "ComponentEvent") event)` \| \| \| `public void` \| `[componentResized](#componentResized(java.awt.event.ComponentEvent))([ComponentEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/ComponentEvent.html "ComponentEvent") event)` \| \| \| `public void` \| `[componentResized](#componentResized(java.awt.event.ComponentEvent))([ComponentEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/ComponentEvent.html "ComponentEvent") event)` \| \| \| `public void` \| `[componentResized](#componentResized(java.awt.event.ComponentEvent))([ComponentEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/ComponentEvent.html "ComponentEvent") event)` \| \| \| `public void` \| `[componentResized](#componentResized(java.awt.event.ComponentEvent))([ComponentEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/ComponentEvent.html "ComponentEvent") event)` \| \| \| `public void` \| `[componentShown](#componentShown(java.awt.event.ComponentEvent))([ComponentEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/ComponentEvent.html "ComponentEvent") event)` \| \| \| `public [FullBinding](../../../org/apache/groovy/swing/binding/fullbinding)` \| `[createBinding](#createBinding(org.apache.groovy.swing.binding.SourceBinding,%20org.apache.groovy.swing.binding.TargetBinding))([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target)` \| \| \| `public [FullBinding](../../../org/apache/groovy/swing/binding/fullbinding)` \| `[createBinding](#createBinding(org.apache.groovy.swing.binding.SourceBinding,%20org.apache.groovy.swing.binding.TargetBinding))([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target)` \| \| \| `public [FullBinding](../../../org/apache/groovy/swing/binding/fullbinding)` \| `[createBinding](#createBinding(org.apache.groovy.swing.binding.SourceBinding,%20org.apache.groovy.swing.binding.TargetBinding))([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target)` \| \| \| `public [FullBinding](../../../org/apache/groovy/swing/binding/fullbinding)` \| `[createBinding](#createBinding(org.apache.groovy.swing.binding.SourceBinding,%20org.apache.groovy.swing.binding.TargetBinding))([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target)` \| \| \| `public [FullBinding](../../../org/apache/groovy/swing/binding/fullbinding)` \| `[createBinding](#createBinding(org.apache.groovy.swing.binding.SourceBinding,%20org.apache.groovy.swing.binding.TargetBinding))([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target)` \| \| \| `public [FullBinding](../../../org/apache/groovy/swing/binding/fullbinding)` \| `[createBinding](#createBinding(org.apache.groovy.swing.binding.SourceBinding,%20org.apache.groovy.swing.binding.TargetBinding))([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target)` \| \| \| `public [FullBinding](../../../org/apache/groovy/swing/binding/fullbinding)` \| `[createBinding](#createBinding(org.apache.groovy.swing.binding.SourceBinding,%20org.apache.groovy.swing.binding.TargetBinding))([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target)` \| \| \| `public static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [TriggerBinding](../../../org/apache/groovy/swing/binding/triggerbinding "TriggerBinding")>` \| `[getSyntheticProperties](#getSyntheticProperties())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void componentHidden([ComponentEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/ComponentEvent.html "ComponentEvent") event) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void componentMoved([ComponentEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/ComponentEvent.html "ComponentEvent") event) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void componentMoved([ComponentEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/ComponentEvent.html "ComponentEvent") event) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void componentMoved([ComponentEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/ComponentEvent.html "ComponentEvent") event) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void componentResized([ComponentEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/ComponentEvent.html "ComponentEvent") event) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void componentResized([ComponentEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/ComponentEvent.html "ComponentEvent") event) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void componentResized([ComponentEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/ComponentEvent.html "ComponentEvent") event) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void componentResized([ComponentEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/ComponentEvent.html "ComponentEvent") event) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void componentShown([ComponentEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/ComponentEvent.html "ComponentEvent") event) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [FullBinding](../../../org/apache/groovy/swing/binding/fullbinding) createBinding([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [FullBinding](../../../org/apache/groovy/swing/binding/fullbinding) createBinding([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [FullBinding](../../../org/apache/groovy/swing/binding/fullbinding) createBinding([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [FullBinding](../../../org/apache/groovy/swing/binding/fullbinding) createBinding([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [FullBinding](../../../org/apache/groovy/swing/binding/fullbinding) createBinding([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [FullBinding](../../../org/apache/groovy/swing/binding/fullbinding) createBinding([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [FullBinding](../../../org/apache/groovy/swing/binding/fullbinding) createBinding([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target) ### public static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [TriggerBinding](../../../org/apache/groovy/swing/binding/triggerbinding "TriggerBinding")> getSyntheticProperties() groovy [Java] Class JTableProperties [Java] Class JTableProperties ============================= * groovy.swing.binding.JTableProperties ``` public class JTableProperties extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [FullBinding](../../../org/apache/groovy/swing/binding/fullbinding)` \| `[createBinding](#createBinding(org.apache.groovy.swing.binding.SourceBinding,%20org.apache.groovy.swing.binding.TargetBinding))([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target)` \| \| \| `public [FullBinding](../../../org/apache/groovy/swing/binding/fullbinding)` \| `[createBinding](#createBinding(org.apache.groovy.swing.binding.SourceBinding,%20org.apache.groovy.swing.binding.TargetBinding))([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target)` \| \| \| `public [FullBinding](../../../org/apache/groovy/swing/binding/fullbinding)` \| `[createBinding](#createBinding(org.apache.groovy.swing.binding.SourceBinding,%20org.apache.groovy.swing.binding.TargetBinding))([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target)` \| \| \| `public static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [TriggerBinding](../../../org/apache/groovy/swing/binding/triggerbinding "TriggerBinding")>` \| `[getSyntheticProperties](#getSyntheticProperties())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [FullBinding](../../../org/apache/groovy/swing/binding/fullbinding) createBinding([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [FullBinding](../../../org/apache/groovy/swing/binding/fullbinding) createBinding([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [FullBinding](../../../org/apache/groovy/swing/binding/fullbinding) createBinding([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target) ### public static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [TriggerBinding](../../../org/apache/groovy/swing/binding/triggerbinding "TriggerBinding")> getSyntheticProperties() groovy [Java] Class JComboBoxProperties [Java] Class JComboBoxProperties ================================ * groovy.swing.binding.JComboBoxProperties ``` public class JComboBoxProperties extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Since: Groovy 1.1 Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [FullBinding](../../../org/apache/groovy/swing/binding/fullbinding)` \| `[createBinding](#createBinding(org.apache.groovy.swing.binding.SourceBinding,%20org.apache.groovy.swing.binding.TargetBinding))([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target)` \| \| \| `public [FullBinding](../../../org/apache/groovy/swing/binding/fullbinding)` \| `[createBinding](#createBinding(org.apache.groovy.swing.binding.SourceBinding,%20org.apache.groovy.swing.binding.TargetBinding))([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target)` \| \| \| `public [FullBinding](../../../org/apache/groovy/swing/binding/fullbinding)` \| `[createBinding](#createBinding(org.apache.groovy.swing.binding.SourceBinding,%20org.apache.groovy.swing.binding.TargetBinding))([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target)` \| \| \| `public [FullBinding](../../../org/apache/groovy/swing/binding/fullbinding)` \| `[createBinding](#createBinding(org.apache.groovy.swing.binding.SourceBinding,%20org.apache.groovy.swing.binding.TargetBinding))([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target)` \| \| \| `public static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [TriggerBinding](../../../org/apache/groovy/swing/binding/triggerbinding "TriggerBinding")>` \| `[getSyntheticProperties](#getSyntheticProperties())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [FullBinding](../../../org/apache/groovy/swing/binding/fullbinding) createBinding([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [FullBinding](../../../org/apache/groovy/swing/binding/fullbinding) createBinding([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [FullBinding](../../../org/apache/groovy/swing/binding/fullbinding) createBinding([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [FullBinding](../../../org/apache/groovy/swing/binding/fullbinding) createBinding([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target) ### public static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [TriggerBinding](../../../org/apache/groovy/swing/binding/triggerbinding "TriggerBinding")> getSyntheticProperties()	programming_docs
groovy [Groovy] Class JListProperties.2 [Groovy] Class JListProperties.2 ================================ * groovy.swing.binding.JListProperties.2 ``` class JListProperties.2 extends [TriggerBinding](../../../org/apache/groovy/swing/binding/triggerbinding) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[JListProperties.2](#JListProperties.2())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[FullBinding](../../../org/apache/groovy/swing/binding/fullbinding)` \| `[createBinding](#createBinding(org.apache.groovy.swing.binding.SourceBinding,%20org.apache.groovy.swing.binding.TargetBinding))([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `interface [TriggerBinding](../../../org/apache/groovy/swing/binding/triggerbinding)` \| `[createBinding](../../../org/apache/groovy/swing/binding/triggerbinding#createBinding(org.apache.groovy.swing.binding.SourceBinding,%20org.apache.groovy.swing.binding.TargetBinding))` \| Constructor Detail ------------------ ### JListProperties.2() Method Detail ------------- ### [FullBinding](../../../org/apache/groovy/swing/binding/fullbinding) createBinding([SourceBinding](../../../org/apache/groovy/swing/binding/sourcebinding) source, [TargetBinding](../../../org/apache/groovy/swing/binding/targetbinding) target) groovy [Java] Class TableSorter [Java] Class TableSorter ======================== * groovy.swing.table.TableSorter ``` public class TableSorter extends [TableMap](tablemap) ``` A sorter for TableModels. The sorter has a model (conforming to TableModel) and itself implements TableModel. TableSorter does not store or copy the data in the TableModel, instead it maintains an array of integers which it keeps the same size as the number of rows in its model. When the model changes it notifies the sorter that something has changed eg. "rowsAdded" so that its internal array of integers can be reallocated. As requests are made of the sorter (like getValueAt(row, col) it redirects them to its model via the mapping array. That way the TableSorter appears to hold another copy of the table with the rows in a different order. The sorting algorithm used is stable which means that it does not move around rows when its comparison function returns 0 to denote that they are equivalent. Inherited fields \| Fields inherited from class \| Fields \| \| `class [TableMap](tablemap)` \| `[model](tablemap#model)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[TableSorter](#TableSorter())()` \| \| `[TableSorter](#TableSorter(javax.swing.table.TableModel))([TableModel](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableModel.html "TableModel") model)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public void` \| `[addMouseListenerToHeaderInTable](#addMouseListenerToHeaderInTable(javax.swing.JTable))([JTable](https://docs.oracle.com/javase/8/docs/api/javax/swing/JTable.html "JTable") table)` \| \| \| `public void` \| `[checkModel](#checkModel())()` \| \| \| `public int` \| `[compare](#compare(int,%20int))(int row1, int row2)` \| \| \| `public int` \| `[compareRowsByColumn](#compareRowsByColumn(int,%20int,%20int))(int row1, int row2, int column)` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getValueAt](#getValueAt(int,%20int))(int aRow, int aColumn)` \| \| \| `public void` \| `[mouseClicked](#mouseClicked(java.awt.event.MouseEvent))([MouseEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/MouseEvent.html "MouseEvent") e)` \| \| \| `public void` \| `[n2sort](#n2sort())()` \| \| \| `public void` \| `[reallocateIndexes](#reallocateIndexes())()` \| \| \| `public void` \| `[setModel](#setModel(javax.swing.table.TableModel))([TableModel](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableModel.html "TableModel") model)` \| \| \| `public void` \| `[setValueAt](#setValueAt(java.lang.Object,%20int,%20int))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") aValue, int aRow, int aColumn)` \| \| \| `public void` \| `[shuttlesort](#shuttlesort(int%5B%5D,%20int%5B%5D,%20int,%20int))(int[] from, int[] to, int low, int high)` \| \| \| `public void` \| `[sort](#sort(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") sender)` \| \| \| `public void` \| `[sortByColumn](#sortByColumn(int))(int column)` \| \| \| `public void` \| `[sortByColumn](#sortByColumn(int,%20boolean))(int column, boolean ascending)` \| \| \| `public void` \| `[swap](#swap(int,%20int))(int i, int j)` \| \| \| `public void` \| `[tableChanged](#tableChanged(javax.swing.event.TableModelEvent))([TableModelEvent](https://docs.oracle.com/javase/8/docs/api/javax/swing/event/TableModelEvent.html "TableModelEvent") e)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [TableMap](tablemap)` \| `[getColumnClass](tablemap#getColumnClass(int)), [getColumnCount](tablemap#getColumnCount()), [getColumnName](tablemap#getColumnName(int)), [getModel](tablemap#getModel()), [getRowCount](tablemap#getRowCount()), [getValueAt](tablemap#getValueAt(int,%20int)), [isCellEditable](tablemap#isCellEditable(int,%20int)), [setModel](tablemap#setModel(javax.swing.table.TableModel)), [setValueAt](tablemap#setValueAt(java.lang.Object,%20int,%20int)), [tableChanged](tablemap#tableChanged(javax.swing.event.TableModelEvent))` \| Constructor Detail ------------------ ### public TableSorter() ### public TableSorter([TableModel](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableModel.html "TableModel") model) Method Detail ------------- ### public void addMouseListenerToHeaderInTable([JTable](https://docs.oracle.com/javase/8/docs/api/javax/swing/JTable.html "JTable") table) ### public void checkModel() ### public int compare(int row1, int row2) ### public int compareRowsByColumn(int row1, int row2, int column) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getValueAt(int aRow, int aColumn) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void mouseClicked([MouseEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/MouseEvent.html "MouseEvent") e) ### public void n2sort() ### public void reallocateIndexes() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void setModel([TableModel](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableModel.html "TableModel") model) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void setValueAt([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") aValue, int aRow, int aColumn) ### public void shuttlesort(int[] from, int[] to, int low, int high) ### public void sort([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") sender) ### public void sortByColumn(int column) ### public void sortByColumn(int column, boolean ascending) ### public void swap(int i, int j) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void tableChanged([TableModelEvent](https://docs.oracle.com/javase/8/docs/api/javax/swing/event/TableModelEvent.html "TableModelEvent") e) groovy [Java] Class TableMap [Java] Class TableMap ===================== * groovy.swing.table.TableMap All Implemented Interfaces and Traits: [TableModelListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/event/TableModelListener.html "TableModelListener") ``` public class TableMap extends [AbstractTableModel](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html "AbstractTableModel") implements [TableModelListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/event/TableModelListener.html "TableModelListener") ``` In a chain of data manipulators some behaviour is common. TableMap provides most of this behaviour and can be subclassed by filters that only need to override a handful of specific methods. TableMap implements TableModel by routing all requests to its model, and TableModelListener by routing all events to its listeners. Inserting a TableMap which has not been subclassed into a chain of table filters should have no effect. Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `protected [TableModel](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableModel.html "TableModel")` \| `[model](#model)` \| \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")` \| `[getColumnClass](#getColumnClass(int))(int aColumn)` \| \| \| `public int` \| `[getColumnCount](#getColumnCount())()` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getColumnName](#getColumnName(int))(int aColumn)` \| \| \| `public [TableModel](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableModel.html "TableModel")` \| `[getModel](#getModel())()` \| \| \| `public int` \| `[getRowCount](#getRowCount())()` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getValueAt](#getValueAt(int,%20int))(int aRow, int aColumn)` \| \| \| `public boolean` \| `[isCellEditable](#isCellEditable(int,%20int))(int row, int column)` \| \| \| `public void` \| `[setModel](#setModel(javax.swing.table.TableModel))([TableModel](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableModel.html "TableModel") model)` \| \| \| `public void` \| `[setValueAt](#setValueAt(java.lang.Object,%20int,%20int))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") aValue, int aRow, int aColumn)` \| \| \| `public void` \| `[tableChanged](#tableChanged(javax.swing.event.TableModelEvent))([TableModelEvent](https://docs.oracle.com/javase/8/docs/api/javax/swing/event/TableModelEvent.html "TableModelEvent") e)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractTableModel](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html "AbstractTableModel")` \| `[getColumnClass](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#getColumnClass(int) "getColumnClass"), [isCellEditable](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#isCellEditable(int,%20int) "isCellEditable"), [setValueAt](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#setValueAt(java.lang.Object,%20int,%20int) "setValueAt"), [addTableModelListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#addTableModelListener(javax.swing.event.TableModelListener) "addTableModelListener"), [removeTableModelListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#removeTableModelListener(javax.swing.event.TableModelListener) "removeTableModelListener"), [getListeners](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#getListeners(java.lang.Class) "getListeners"), [fireTableStructureChanged](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#fireTableStructureChanged() "fireTableStructureChanged"), [fireTableChanged](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#fireTableChanged(javax.swing.event.TableModelEvent) "fireTableChanged"), [fireTableRowsDeleted](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#fireTableRowsDeleted(int,%20int) "fireTableRowsDeleted"), [fireTableRowsInserted](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#fireTableRowsInserted(int,%20int) "fireTableRowsInserted"), [fireTableRowsUpdated](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#fireTableRowsUpdated(int,%20int) "fireTableRowsUpdated"), [fireTableCellUpdated](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#fireTableCellUpdated(int,%20int) "fireTableCellUpdated"), [getTableModelListeners](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#getTableModelListeners() "getTableModelListeners"), [fireTableDataChanged](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#fireTableDataChanged() "fireTableDataChanged"), [getColumnName](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#getColumnName(int) "getColumnName"), [findColumn](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#findColumn(java.lang.String) "findColumn"), [wait](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#notifyAll() "notifyAll"), [getColumnCount](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#getColumnCount() "getColumnCount"), [getValueAt](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#getValueAt(int,%20int) "getValueAt"), [getRowCount](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#getRowCount() "getRowCount")` \| Field Detail ------------ ### protected [TableModel](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableModel.html "TableModel") model Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") getColumnClass(int aColumn) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public int getColumnCount() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getColumnName(int aColumn) ### public [TableModel](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableModel.html "TableModel") getModel() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public int getRowCount() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getValueAt(int aRow, int aColumn) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean isCellEditable(int row, int column) ### public void setModel([TableModel](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableModel.html "TableModel") model) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void setValueAt([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") aValue, int aRow, int aColumn) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void tableChanged([TableModelEvent](https://docs.oracle.com/javase/8/docs/api/javax/swing/event/TableModelEvent.html "TableModelEvent") e) groovy [Java] Class ClosureModel [Java] Class ClosureModel ========================= * groovy.swing.model.ClosureModel All Implemented Interfaces and Traits: [NestedValueModel](nestedvaluemodel), [ValueModel](valuemodel) ``` public class ClosureModel extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") implements [NestedValueModel](nestedvaluemodel), [ValueModel](valuemodel) ``` Represents a value model using a closure to extract the value from some source model and an optional write closure for updating the value. Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[ClosureModel](#ClosureModel(groovy.swing.model.ValueModel,%20groovy.lang.Closure))([ValueModel](valuemodel) sourceModel, [Closure](../../lang/closure) readClosure)` \| \| `[ClosureModel](#ClosureModel(groovy.swing.model.ValueModel,%20groovy.lang.Closure,%20groovy.lang.Closure))([ValueModel](valuemodel) sourceModel, [Closure](../../lang/closure) readClosure, [Closure](../../lang/closure) writeClosure)` \| \| `[ClosureModel](#ClosureModel(groovy.swing.model.ValueModel,%20groovy.lang.Closure,%20groovy.lang.Closure,%20java.lang.Class))([ValueModel](valuemodel) sourceModel, [Closure](../../lang/closure) readClosure, [Closure](../../lang/closure) writeClosure, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") type)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [ValueModel](valuemodel)` \| `[getSourceModel](#getSourceModel())()` \| \| \| `public [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")` \| `[getType](#getType())()` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getValue](#getValue())()` \| \| \| `public boolean` \| `[isEditable](#isEditable())()` \| \| \| `public void` \| `[setValue](#setValue(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public ClosureModel([ValueModel](valuemodel) sourceModel, [Closure](../../lang/closure) readClosure) ### public ClosureModel([ValueModel](valuemodel) sourceModel, [Closure](../../lang/closure) readClosure, [Closure](../../lang/closure) writeClosure) ### public ClosureModel([ValueModel](valuemodel) sourceModel, [Closure](../../lang/closure) readClosure, [Closure](../../lang/closure) writeClosure, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") type) Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ValueModel](valuemodel) getSourceModel() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") getType() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getValue() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean isEditable() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void setValue([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)	programming_docs
groovy [Java] Interface NestedValueModel [Java] Interface NestedValueModel ================================= ``` public interface NestedValueModel ``` Represents a nested value model such as a PropertyModel or a ClosureModel Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [ValueModel](valuemodel)` \| `[getSourceModel](#getSourceModel())()` \| Method Detail ------------- ### public [ValueModel](valuemodel) getSourceModel() groovy [Java] Interface ValueModel [Java] Interface ValueModel =========================== ``` public interface ValueModel ``` Represents a model of a value Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")` \| `[getType](#getType())()` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getValue](#getValue())()` \| \| \| `public boolean` \| `[isEditable](#isEditable())()` \| \| \| `public void` \| `[setValue](#setValue(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| Method Detail ------------- ### public [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") getType() ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getValue() ### public boolean isEditable() ### public void setValue([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) groovy [Java] Class DefaultTableModel [Java] Class DefaultTableModel ============================== * groovy.swing.model.DefaultTableModel ``` public class DefaultTableModel extends [AbstractTableModel](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html "AbstractTableModel") ``` A default table model made up of PropertyModels on a Value model. Nested Class Summary -------------------- Nested classes \| Modifiers \| Name \| Description \| \| `protected static class` \| `[DefaultTableModel.MyTableColumnModel](defaulttablemodel.mytablecolumnmodel)` \| \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[DefaultTableModel](#DefaultTableModel(groovy.swing.model.ValueModel))([ValueModel](valuemodel) rowsModel)` \| \| `[DefaultTableModel](#DefaultTableModel(groovy.swing.model.ValueModel,%20groovy.swing.model.ValueModel))([ValueModel](valuemodel) rowsModel, [ValueModel](valuemodel) rowModel)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [DefaultTableColumn](defaulttablecolumn)` \| `[addClosureColumn](#addClosureColumn(java.lang.Object,%20groovy.lang.Closure,%20groovy.lang.Closure,%20java.lang.Class))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") headerValue, [Closure](../../lang/closure) readClosure, [Closure](../../lang/closure) writeClosure, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") type)`Adds a closure based column to the table \| \| \| `public [DefaultTableColumn](defaulttablecolumn)` \| `[addColumn](#addColumn(java.lang.Object,%20groovy.swing.model.ValueModel))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") headerValue, [ValueModel](valuemodel) columnValueModel)` \| \| \| `public [DefaultTableColumn](defaulttablecolumn)` \| `[addColumn](#addColumn(java.lang.Object,%20java.lang.Object,%20groovy.swing.model.ValueModel))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") headerValue, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") identifier, [ValueModel](valuemodel) columnValueModel)` \| \| \| `public void` \| `[addColumn](#addColumn(groovy.swing.model.DefaultTableColumn))([DefaultTableColumn](defaulttablecolumn) column)`Adds a new column definition to the table \| \| \| `public [DefaultTableColumn](defaulttablecolumn)` \| `[addPropertyColumn](#addPropertyColumn(java.lang.Object,%20java.lang.String,%20java.lang.Class))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") headerValue, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") property, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") type)`Adds a property model column to the table \| \| \| `public [DefaultTableColumn](defaulttablecolumn)` \| `[addPropertyColumn](#addPropertyColumn(java.lang.Object,%20java.lang.String,%20java.lang.Class,%20boolean))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") headerValue, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") property, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") type, boolean editable)`Adds a property model column to the table \| \| \| `public [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")` \| `[getColumnClass](#getColumnClass(int))(int columnIndex)` \| \| \| `public int` \| `[getColumnCount](#getColumnCount())()` \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")` \| `[getColumnList](#getColumnList())()` Returns: the column definitions. \| \| \| `public [TableColumnModel](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableColumnModel.html "TableColumnModel")` \| `[getColumnModel](#getColumnModel())()` \| \| \| `protected [ValueModel](valuemodel)` \| `[getColumnModel](#getColumnModel(int))(int columnIndex)` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getColumnName](#getColumnName(int))(int columnIndex)` \| \| \| `public int` \| `[getRowCount](#getRowCount())()` \| \| \| `public [ValueModel](valuemodel)` \| `[getRowModel](#getRowModel())()` \| \| \| `protected [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")` \| `[getRows](#getRows())()` \| \| \| `public [ValueModel](valuemodel)` \| `[getRowsModel](#getRowsModel())()` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getValueAt](#getValueAt(int,%20int))(int rowIndex, int columnIndex)` \| \| \| `public boolean` \| `[isCellEditable](#isCellEditable(int,%20int))(int rowIndex, int columnIndex)` \| \| \| `public void` \| `[removeColumn](#removeColumn(groovy.swing.model.DefaultTableColumn))([DefaultTableColumn](defaulttablecolumn) column)`Removes a column definition from the table \| \| \| `public void` \| `[setValueAt](#setValueAt(java.lang.Object,%20int,%20int))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, int rowIndex, int columnIndex)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractTableModel](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html "AbstractTableModel")` \| `[getColumnClass](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#getColumnClass(int) "getColumnClass"), [isCellEditable](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#isCellEditable(int,%20int) "isCellEditable"), [setValueAt](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#setValueAt(java.lang.Object,%20int,%20int) "setValueAt"), [addTableModelListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#addTableModelListener(javax.swing.event.TableModelListener) "addTableModelListener"), [removeTableModelListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#removeTableModelListener(javax.swing.event.TableModelListener) "removeTableModelListener"), [getListeners](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#getListeners(java.lang.Class) "getListeners"), [fireTableStructureChanged](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#fireTableStructureChanged() "fireTableStructureChanged"), [fireTableChanged](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#fireTableChanged(javax.swing.event.TableModelEvent) "fireTableChanged"), [fireTableRowsDeleted](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#fireTableRowsDeleted(int,%20int) "fireTableRowsDeleted"), [fireTableRowsInserted](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#fireTableRowsInserted(int,%20int) "fireTableRowsInserted"), [fireTableRowsUpdated](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#fireTableRowsUpdated(int,%20int) "fireTableRowsUpdated"), [fireTableCellUpdated](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#fireTableCellUpdated(int,%20int) "fireTableCellUpdated"), [getTableModelListeners](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#getTableModelListeners() "getTableModelListeners"), [fireTableDataChanged](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#fireTableDataChanged() "fireTableDataChanged"), [getColumnName](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#getColumnName(int) "getColumnName"), [findColumn](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#findColumn(java.lang.String) "findColumn"), [wait](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#notifyAll() "notifyAll"), [getColumnCount](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#getColumnCount() "getColumnCount"), [getValueAt](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#getValueAt(int,%20int) "getValueAt"), [getRowCount](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/AbstractTableModel.html#getRowCount() "getRowCount")` \| Constructor Detail ------------------ ### public DefaultTableModel([ValueModel](valuemodel) rowsModel) ### public DefaultTableModel([ValueModel](valuemodel) rowsModel, [ValueModel](valuemodel) rowModel) Method Detail ------------- ### public [DefaultTableColumn](defaulttablecolumn) addClosureColumn([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") headerValue, [Closure](../../lang/closure) readClosure, [Closure](../../lang/closure) writeClosure, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") type) Adds a closure based column to the table ### public [DefaultTableColumn](defaulttablecolumn) addColumn([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") headerValue, [ValueModel](valuemodel) columnValueModel) ### public [DefaultTableColumn](defaulttablecolumn) addColumn([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") headerValue, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") identifier, [ValueModel](valuemodel) columnValueModel) ### public void addColumn([DefaultTableColumn](defaulttablecolumn) column) Adds a new column definition to the table ### public [DefaultTableColumn](defaulttablecolumn) addPropertyColumn([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") headerValue, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") property, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") type) Adds a property model column to the table ### public [DefaultTableColumn](defaulttablecolumn) addPropertyColumn([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") headerValue, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") property, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") type, boolean editable) Adds a property model column to the table ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") getColumnClass(int columnIndex) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public int getColumnCount() ### public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") getColumnList() Returns: the column definitions. ### public [TableColumnModel](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableColumnModel.html "TableColumnModel") getColumnModel() ### protected [ValueModel](valuemodel) getColumnModel(int columnIndex) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getColumnName(int columnIndex) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public int getRowCount() ### public [ValueModel](valuemodel) getRowModel() ### protected [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") getRows() ### public [ValueModel](valuemodel) getRowsModel() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getValueAt(int rowIndex, int columnIndex) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean isCellEditable(int rowIndex, int columnIndex) ### public void removeColumn([DefaultTableColumn](defaulttablecolumn) column) Removes a column definition from the table ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void setValueAt([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, int rowIndex, int columnIndex) groovy [Java] Class PropertyModel [Java] Class PropertyModel ========================== * groovy.swing.model.PropertyModel All Implemented Interfaces and Traits: [NestedValueModel](nestedvaluemodel), [ValueModel](valuemodel) ``` public class PropertyModel extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") implements [NestedValueModel](nestedvaluemodel), [ValueModel](valuemodel) ``` Represents a property of a value as a model. Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[PropertyModel](#PropertyModel(groovy.swing.model.ValueModel,%20java.lang.String))([ValueModel](valuemodel) sourceModel, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") property)` \| \| `[PropertyModel](#PropertyModel(groovy.swing.model.ValueModel,%20java.lang.String,%20java.lang.Class))([ValueModel](valuemodel) sourceModel, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") property, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") type)` \| \| `[PropertyModel](#PropertyModel(groovy.swing.model.ValueModel,%20java.lang.String,%20java.lang.Class,%20boolean))([ValueModel](valuemodel) sourceModel, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") property, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") type, boolean editable)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getProperty](#getProperty())()` \| \| \| `public [ValueModel](valuemodel)` \| `[getSourceModel](#getSourceModel())()` \| \| \| `public [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")` \| `[getType](#getType())()` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getValue](#getValue())()` \| \| \| `public boolean` \| `[isEditable](#isEditable())()` \| \| \| `public void` \| `[setValue](#setValue(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public PropertyModel([ValueModel](valuemodel) sourceModel, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") property) ### public PropertyModel([ValueModel](valuemodel) sourceModel, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") property, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") type) ### public PropertyModel([ValueModel](valuemodel) sourceModel, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") property, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") type, boolean editable) Method Detail ------------- ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getProperty() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [ValueModel](valuemodel) getSourceModel() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") getType() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getValue() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean isEditable() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void setValue([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)	programming_docs
groovy [Java] Class FormModel [Java] Class FormModel ====================== * groovy.swing.model.FormModel ``` public class FormModel extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Represents a number of field models which can be ValueModel, PropertyModel, TableModel, TreeModel or nested FormModel instances Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[FormModel](#FormModel())()` \| \| `[FormModel](#FormModel(Map))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")> fieldModels)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public void` \| `[addModel](#addModel(java.lang.String,%20java.lang.Object))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") model)` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getModel](#getModel(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public FormModel() ### public FormModel([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")> fieldModels) Method Detail ------------- ### public void addModel([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") model) ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getModel([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name) groovy [Java] Class ValueHolder [Java] Class ValueHolder ======================== * groovy.swing.model.ValueHolder All Implemented Interfaces and Traits: [ValueModel](valuemodel) ``` public class ValueHolder extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") implements [ValueModel](valuemodel) ``` A simple ValueModel implementation which is a holder of an object value. Used to share local variables with closures Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[ValueHolder](#ValueHolder())()` \| \| `[ValueHolder](#ValueHolder(java.lang.Class))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") type)` \| \| `[ValueHolder](#ValueHolder(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public void` \| `[addPropertyChangeListener](#addPropertyChangeListener(java.beans.PropertyChangeListener))([PropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html "PropertyChangeListener") listener)`Add a PropertyChangeListener to the listener list. \| \| \| `public [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")` \| `[getType](#getType())()` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getValue](#getValue())()` \| \| \| `public boolean` \| `[isEditable](#isEditable())()` \| \| \| `public void` \| `[removePropertyChangeListener](#removePropertyChangeListener(java.beans.PropertyChangeListener))([PropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html "PropertyChangeListener") listener)`Removes a PropertyChangeListener from the listener list. \| \| \| `public void` \| `[setEditable](#setEditable(boolean))(boolean editable)` \| \| \| `public void` \| `[setValue](#setValue(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public ValueHolder() ### public ValueHolder([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") type) ### public ValueHolder([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) Method Detail ------------- ### public void addPropertyChangeListener([PropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html "PropertyChangeListener") listener) Add a PropertyChangeListener to the listener list. Parameters: `listener` - The listener to add. ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") getType() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getValue() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean isEditable() ### public void removePropertyChangeListener([PropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html "PropertyChangeListener") listener) Removes a PropertyChangeListener from the listener list. Parameters: `listener` - The listener to remove. ### public void setEditable(boolean editable) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void setValue([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) groovy [Java] Class DefaultTableModel.MyTableColumnModel [Java] Class DefaultTableModel.MyTableColumnModel ================================================= * groovy.swing.model.DefaultTableModel.MyTableColumnModel ``` protected static class DefaultTableModel.MyTableColumnModel extends [DefaultTableColumnModel](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/DefaultTableColumnModel.html "DefaultTableColumnModel") ``` Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")` \| `[getColumnList](#getColumnList())()` \| \| \| `public void` \| `[moveColumn](#moveColumn(int,%20int))(int columnIndex, int newIndex)` \| \| \| `public void` \| `[removeColumn](#removeColumn(javax.swing.table.TableColumn))([TableColumn](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableColumn.html "TableColumn") column)` \| \| \| `public void` \| `[renumberTableColumns](#renumberTableColumns())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [DefaultTableColumnModel](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/DefaultTableColumnModel.html "DefaultTableColumnModel")` \| `[propertyChange](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/DefaultTableColumnModel.html#propertyChange(java.beans.PropertyChangeEvent) "propertyChange"), [removeColumn](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/DefaultTableColumnModel.html#removeColumn(javax.swing.table.TableColumn) "removeColumn"), [moveColumn](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/DefaultTableColumnModel.html#moveColumn(int,%20int) "moveColumn"), [setColumnMargin](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/DefaultTableColumnModel.html#setColumnMargin(int) "setColumnMargin"), [getColumns](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/DefaultTableColumnModel.html#getColumns() "getColumns"), [getColumnIndex](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/DefaultTableColumnModel.html#getColumnIndex(java.lang.Object) "getColumnIndex"), [getColumnMargin](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/DefaultTableColumnModel.html#getColumnMargin() "getColumnMargin"), [getColumnIndexAtX](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/DefaultTableColumnModel.html#getColumnIndexAtX(int) "getColumnIndexAtX"), [getTotalColumnWidth](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/DefaultTableColumnModel.html#getTotalColumnWidth() "getTotalColumnWidth"), [setColumnSelectionAllowed](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/DefaultTableColumnModel.html#setColumnSelectionAllowed(boolean) "setColumnSelectionAllowed"), [getColumnSelectionAllowed](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/DefaultTableColumnModel.html#getColumnSelectionAllowed() "getColumnSelectionAllowed"), [getSelectedColumns](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/DefaultTableColumnModel.html#getSelectedColumns() "getSelectedColumns"), [getSelectedColumnCount](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/DefaultTableColumnModel.html#getSelectedColumnCount() "getSelectedColumnCount"), [setSelectionModel](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/DefaultTableColumnModel.html#setSelectionModel(javax.swing.ListSelectionModel) "setSelectionModel"), [getSelectionModel](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/DefaultTableColumnModel.html#getSelectionModel() "getSelectionModel"), [addColumnModelListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/DefaultTableColumnModel.html#addColumnModelListener(javax.swing.event.TableColumnModelListener) "addColumnModelListener"), [removeColumnModelListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/DefaultTableColumnModel.html#removeColumnModelListener(javax.swing.event.TableColumnModelListener) "removeColumnModelListener"), [getListeners](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/DefaultTableColumnModel.html#getListeners(java.lang.Class) "getListeners"), [valueChanged](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/DefaultTableColumnModel.html#valueChanged(javax.swing.event.ListSelectionEvent) "valueChanged"), [getColumnCount](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/DefaultTableColumnModel.html#getColumnCount() "getColumnCount"), [getColumn](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/DefaultTableColumnModel.html#getColumn(int) "getColumn"), [addColumn](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/DefaultTableColumnModel.html#addColumn(javax.swing.table.TableColumn) "addColumn"), [getColumnModelListeners](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/DefaultTableColumnModel.html#getColumnModelListeners() "getColumnModelListeners"), [wait](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/DefaultTableColumnModel.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/DefaultTableColumnModel.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/DefaultTableColumnModel.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/DefaultTableColumnModel.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/DefaultTableColumnModel.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/DefaultTableColumnModel.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/DefaultTableColumnModel.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/DefaultTableColumnModel.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/DefaultTableColumnModel.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") getColumnList() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void moveColumn(int columnIndex, int newIndex) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void removeColumn([TableColumn](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableColumn.html "TableColumn") column) ### public void renumberTableColumns() groovy [Java] Class DefaultTableColumn [Java] Class DefaultTableColumn =============================== * groovy.swing.model.DefaultTableColumn ``` public class DefaultTableColumn extends [TableColumn](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableColumn.html "TableColumn") ``` Represents a column using a ValueModel to extract the value. Inherited fields \| Fields inherited from class \| Fields \| \| `class [TableColumn](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableColumn.html "TableColumn")` \| `COLUMN_WIDTH_PROPERTY, HEADER_VALUE_PROPERTY, HEADER_RENDERER_PROPERTY, CELL_RENDERER_PROPERTY` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[DefaultTableColumn](#DefaultTableColumn(groovy.swing.model.ValueModel))([ValueModel](valuemodel) valueModel)` \| \| `[DefaultTableColumn](#DefaultTableColumn(java.lang.Object,%20groovy.swing.model.ValueModel))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") header, [ValueModel](valuemodel) valueModel)` \| \| `[DefaultTableColumn](#DefaultTableColumn(java.lang.Object,%20java.lang.Object,%20groovy.swing.model.ValueModel))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") headerValue, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") identifier, [ValueModel](valuemodel) columnValueModel)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")` \| `[getType](#getType())()` Returns: the column type \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getValue](#getValue(java.lang.Object,%20int,%20int))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") row, int rowIndex, int columnIndex)`Evaluates the value of a cell \| \| \| `public [ValueModel](valuemodel)` \| `[getValueModel](#getValueModel())()` \| \| \| `public void` \| `[setValue](#setValue(java.lang.Object,%20java.lang.Object,%20int,%20int))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") row, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, int rowIndex, int columnIndex)` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[toString](#toString())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [TableColumn](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableColumn.html "TableColumn")` \| `[getIdentifier](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableColumn.html#getIdentifier() "getIdentifier"), [getPropertyChangeListeners](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableColumn.html#getPropertyChangeListeners() "getPropertyChangeListeners"), [removePropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableColumn.html#removePropertyChangeListener(java.beans.PropertyChangeListener) "removePropertyChangeListener"), [getWidth](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableColumn.html#getWidth() "getWidth"), [getHeaderValue](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableColumn.html#getHeaderValue() "getHeaderValue"), [setWidth](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableColumn.html#setWidth(int) "setWidth"), [setPreferredWidth](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableColumn.html#setPreferredWidth(int) "setPreferredWidth"), [setMinWidth](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableColumn.html#setMinWidth(int) "setMinWidth"), [setMaxWidth](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableColumn.html#setMaxWidth(int) "setMaxWidth"), [getPreferredWidth](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableColumn.html#getPreferredWidth() "getPreferredWidth"), [setModelIndex](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableColumn.html#setModelIndex(int) "setModelIndex"), [getModelIndex](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableColumn.html#getModelIndex() "getModelIndex"), [setIdentifier](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableColumn.html#setIdentifier(java.lang.Object) "setIdentifier"), [setHeaderValue](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableColumn.html#setHeaderValue(java.lang.Object) "setHeaderValue"), [setHeaderRenderer](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableColumn.html#setHeaderRenderer(javax.swing.table.TableCellRenderer) "setHeaderRenderer"), [getHeaderRenderer](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableColumn.html#getHeaderRenderer() "getHeaderRenderer"), [setCellRenderer](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableColumn.html#setCellRenderer(javax.swing.table.TableCellRenderer) "setCellRenderer"), [getCellRenderer](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableColumn.html#getCellRenderer() "getCellRenderer"), [setCellEditor](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableColumn.html#setCellEditor(javax.swing.table.TableCellEditor) "setCellEditor"), [getCellEditor](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableColumn.html#getCellEditor() "getCellEditor"), [getMinWidth](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableColumn.html#getMinWidth() "getMinWidth"), [getMaxWidth](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableColumn.html#getMaxWidth() "getMaxWidth"), [setResizable](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableColumn.html#setResizable(boolean) "setResizable"), [getResizable](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableColumn.html#getResizable() "getResizable"), [sizeWidthToFit](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableColumn.html#sizeWidthToFit() "sizeWidthToFit"), [disableResizedPosting](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableColumn.html#disableResizedPosting() "disableResizedPosting"), [enableResizedPosting](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableColumn.html#enableResizedPosting() "enableResizedPosting"), [addPropertyChangeListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableColumn.html#addPropertyChangeListener(java.beans.PropertyChangeListener) "addPropertyChangeListener"), [wait](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableColumn.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableColumn.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableColumn.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableColumn.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableColumn.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableColumn.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableColumn.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableColumn.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableColumn.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public DefaultTableColumn([ValueModel](valuemodel) valueModel) ### public DefaultTableColumn([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") header, [ValueModel](valuemodel) valueModel) ### public DefaultTableColumn([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") headerValue, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") identifier, [ValueModel](valuemodel) columnValueModel) Method Detail ------------- ### public [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") getType() Returns: the column type ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getValue([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") row, int rowIndex, int columnIndex) Evaluates the value of a cell Returns: the value Parameters: `row` - the row of interest `rowIndex` - the index of the row of interest `columnIndex` - the column of interest ### public [ValueModel](valuemodel) getValueModel() ### public void setValue([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") row, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, int rowIndex, int columnIndex) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") toString()	programming_docs
groovy [Groovy] Class InternalFrameFactory [Groovy] Class InternalFrameFactory =================================== * groovy.swing.factory.InternalFrameFactory ``` class InternalFrameFactory extends [RootPaneContainerFactory](rootpanecontainerfactory) ``` Inherited fields \| Fields inherited from class \| Fields \| \| `class [RootPaneContainerFactory](rootpanecontainerfactory)` \| `[DEFAULT\_DELEGATE\_PROPERTY\_DEFAULT\_BUTTON](rootpanecontainerfactory#DEFAULT_DELEGATE_PROPERTY_DEFAULT_BUTTON), [DELEGATE\_PROPERTY\_DEFAULT\_BUTTON](rootpanecontainerfactory#DELEGATE_PROPERTY_DEFAULT_BUTTON)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[InternalFrameFactory](#InternalFrameFactory())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [RootPaneContainerFactory](rootpanecontainerfactory)` \| `[handleRootPaneTasks](rootpanecontainerfactory#handleRootPaneTasks(groovy.util.FactoryBuilderSupport,%20java.awt.Window,%20java.util.Map)), [onNodeCompleted](rootpanecontainerfactory#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object)), [setChild](rootpanecontainerfactory#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))` \| Constructor Detail ------------------ ### InternalFrameFactory() Method Detail ------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) groovy [Groovy] Class ColumnFactory [Groovy] Class ColumnFactory ============================ * groovy.swing.factory.ColumnFactory ``` @[Log](../../util/logging/log "Log") class ColumnFactory extends [AbstractFactory](../../util/abstractfactory "AbstractFactory") ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[ColumnFactory](#ColumnFactory())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| \| \| `void` \| `[onNodeCompleted](#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node)` \| \| \| `void` \| `[setChild](#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractFactory](../../util/abstractfactory "AbstractFactory")` \| `[setParent](../../util/abstractfactory#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setParent"), [isLeaf](../../util/abstractfactory#isLeaf() "isLeaf"), [onNodeChildren](../../util/abstractfactory#onNodeChildren(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20groovy.lang.Closure) "onNodeChildren"), [setChild](../../util/abstractfactory#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setChild"), [onNodeCompleted](../../util/abstractfactory#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "onNodeCompleted"), [onFactoryRegistration](../../util/abstractfactory#onFactoryRegistration(groovy.util.FactoryBuilderSupport,%20java.lang.String,%20java.lang.String) "onFactoryRegistration"), [isHandlesNodeChildren](../../util/abstractfactory#isHandlesNodeChildren() "isHandlesNodeChildren"), [onHandleNodeAttributes](../../util/abstractfactory#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map) "onHandleNodeAttributes"), [wait](../../util/abstractfactory#wait(long,%20int) "wait"), [wait](../../util/abstractfactory#wait() "wait"), [wait](../../util/abstractfactory#wait(long) "wait"), [equals](../../util/abstractfactory#equals(java.lang.Object) "equals"), [toString](../../util/abstractfactory#toString() "toString"), [hashCode](../../util/abstractfactory#hashCode() "hashCode"), [getClass](../../util/abstractfactory#getClass() "getClass"), [notify](../../util/abstractfactory#notify() "notify"), [notifyAll](../../util/abstractfactory#notifyAll() "notifyAll"), [newInstance](../../util/abstractfactory#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map) "newInstance")` \| Constructor Detail ------------------ ### ColumnFactory() Method Detail ------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) ### void onNodeCompleted([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node) ### void setChild([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child) groovy [Groovy] Class CompoundBorderFactory [Groovy] Class CompoundBorderFactory ==================================== * groovy.swing.factory.CompoundBorderFactory ``` class CompoundBorderFactory extends [SwingBorderFactory](swingborderfactory) ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[CompoundBorderFactory](#CompoundBorderFactory())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [SwingBorderFactory](swingborderfactory)` \| `[isLeaf](swingborderfactory#isLeaf()), [onHandleNodeAttributes](swingborderfactory#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map)), [setParent](swingborderfactory#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))` \| Constructor Detail ------------------ ### CompoundBorderFactory() Method Detail ------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) groovy [Groovy] Class BevelBorderFactory [Groovy] Class BevelBorderFactory ================================= * groovy.swing.factory.BevelBorderFactory ``` class BevelBorderFactory extends [SwingBorderFactory](swingborderfactory) ``` accepts no value accepts attributes: none highlight: java.awt.Color, shadow: java.awt.Color highlightOuter: java.awt.Color, highlightInner: java.awt.Color, shadowOuter: java.awt.Color, shadowInner: java.awt.Color Properties Summary ------------------ Properties \| Type \| Name and description \| \| `int` \| `[type](#type)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[BevelBorderFactory](#BevelBorderFactory(int))(int newType)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [SwingBorderFactory](swingborderfactory)` \| `[isLeaf](swingborderfactory#isLeaf()), [onHandleNodeAttributes](swingborderfactory#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map)), [setParent](swingborderfactory#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))` \| Property Detail --------------- ### final int type Constructor Detail ------------------ ### BevelBorderFactory(int newType) Method Detail ------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) groovy [Groovy] Class TableFactory [Groovy] Class TableFactory =========================== * groovy.swing.factory.TableFactory ``` class TableFactory extends [BeanFactory](beanfactory) ``` Inherited fields \| Fields inherited from class \| Fields \| \| `class [BeanFactory](beanfactory)` \| `[leaf](beanfactory#leaf)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[TableFactory](#TableFactory())()` \| \| `[TableFactory](#TableFactory(java.lang.Class))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") klass)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| \| \| `void` \| `[setChild](#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [BeanFactory](beanfactory)` \| `[isLeaf](beanfactory#isLeaf()), [newInstance](beanfactory#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))` \| Constructor Detail ------------------ ### TableFactory() ### TableFactory([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") klass) Method Detail ------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) ### void setChild([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child) groovy [Groovy] Class ScrollPaneFactory [Groovy] Class ScrollPaneFactory ================================ * groovy.swing.factory.ScrollPaneFactory ``` class ScrollPaneFactory extends [BeanFactory](beanfactory) ``` Inherited fields \| Fields inherited from class \| Fields \| \| `class [BeanFactory](beanfactory)` \| `[leaf](beanfactory#leaf)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[ScrollPaneFactory](#ScrollPaneFactory())()` \| \| `[ScrollPaneFactory](#ScrollPaneFactory(java.lang.Class))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") klass)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `void` \| `[setChild](#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))([FactoryBuilderSupport](../../util/factorybuildersupport) factory, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [BeanFactory](beanfactory)` \| `[isLeaf](beanfactory#isLeaf()), [newInstance](beanfactory#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))` \| Constructor Detail ------------------ ### ScrollPaneFactory() ### ScrollPaneFactory([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") klass) Method Detail ------------- ### void setChild([FactoryBuilderSupport](../../util/factorybuildersupport) factory, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child) groovy [Groovy] Class ListFactory [Groovy] Class ListFactory ========================== * groovy.swing.factory.ListFactory ``` class ListFactory extends [AbstractFactory](../../util/abstractfactory "AbstractFactory") ``` Create a JList, and handle the optional items attribute. Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[ListFactory](#ListFactory())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| \| \| `boolean` \| `[onHandleNodeAttributes](#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractFactory](../../util/abstractfactory "AbstractFactory")` \| `[setParent](../../util/abstractfactory#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setParent"), [isLeaf](../../util/abstractfactory#isLeaf() "isLeaf"), [onNodeChildren](../../util/abstractfactory#onNodeChildren(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20groovy.lang.Closure) "onNodeChildren"), [setChild](../../util/abstractfactory#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setChild"), [onNodeCompleted](../../util/abstractfactory#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "onNodeCompleted"), [onFactoryRegistration](../../util/abstractfactory#onFactoryRegistration(groovy.util.FactoryBuilderSupport,%20java.lang.String,%20java.lang.String) "onFactoryRegistration"), [isHandlesNodeChildren](../../util/abstractfactory#isHandlesNodeChildren() "isHandlesNodeChildren"), [onHandleNodeAttributes](../../util/abstractfactory#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map) "onHandleNodeAttributes"), [wait](../../util/abstractfactory#wait(long,%20int) "wait"), [wait](../../util/abstractfactory#wait() "wait"), [wait](../../util/abstractfactory#wait(long) "wait"), [equals](../../util/abstractfactory#equals(java.lang.Object) "equals"), [toString](../../util/abstractfactory#toString() "toString"), [hashCode](../../util/abstractfactory#hashCode() "hashCode"), [getClass](../../util/abstractfactory#getClass() "getClass"), [notify](../../util/abstractfactory#notify() "notify"), [notifyAll](../../util/abstractfactory#notifyAll() "notifyAll"), [newInstance](../../util/abstractfactory#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map) "newInstance")` \| Constructor Detail ------------------ ### ListFactory() Method Detail ------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) ### boolean onHandleNodeAttributes([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)	programming_docs
groovy [Groovy] Class ComponentFactory [Groovy] Class ComponentFactory =============================== * groovy.swing.factory.ComponentFactory ``` class ComponentFactory extends [BeanFactory](beanfactory) ``` Inherited fields \| Fields inherited from class \| Fields \| \| `class [BeanFactory](beanfactory)` \| `[leaf](beanfactory#leaf)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[ComponentFactory](#ComponentFactory(java.lang.Class))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") beanClass)` \| \| `[ComponentFactory](#ComponentFactory(java.lang.Class,%20boolean))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") beanClass, boolean leaf)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `void` \| `[setChild](#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [BeanFactory](beanfactory)` \| `[isLeaf](beanfactory#isLeaf()), [newInstance](beanfactory#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))` \| Constructor Detail ------------------ ### ComponentFactory([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") beanClass) ### ComponentFactory([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") beanClass, boolean leaf) Method Detail ------------- ### void setChild([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child) groovy [Groovy] Class BoxLayoutFactory [Groovy] Class BoxLayoutFactory =============================== * groovy.swing.factory.BoxLayoutFactory ``` class BoxLayoutFactory extends [AbstractFactory](../../util/abstractfactory "AbstractFactory") ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[BoxLayoutFactory](#BoxLayoutFactory())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| \| \| `void` \| `[setParent](#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractFactory](../../util/abstractfactory "AbstractFactory")` \| `[setParent](../../util/abstractfactory#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setParent"), [isLeaf](../../util/abstractfactory#isLeaf() "isLeaf"), [onNodeChildren](../../util/abstractfactory#onNodeChildren(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20groovy.lang.Closure) "onNodeChildren"), [setChild](../../util/abstractfactory#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setChild"), [onNodeCompleted](../../util/abstractfactory#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "onNodeCompleted"), [onFactoryRegistration](../../util/abstractfactory#onFactoryRegistration(groovy.util.FactoryBuilderSupport,%20java.lang.String,%20java.lang.String) "onFactoryRegistration"), [isHandlesNodeChildren](../../util/abstractfactory#isHandlesNodeChildren() "isHandlesNodeChildren"), [onHandleNodeAttributes](../../util/abstractfactory#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map) "onHandleNodeAttributes"), [wait](../../util/abstractfactory#wait(long,%20int) "wait"), [wait](../../util/abstractfactory#wait() "wait"), [wait](../../util/abstractfactory#wait(long) "wait"), [equals](../../util/abstractfactory#equals(java.lang.Object) "equals"), [toString](../../util/abstractfactory#toString() "toString"), [hashCode](../../util/abstractfactory#hashCode() "hashCode"), [getClass](../../util/abstractfactory#getClass() "getClass"), [notify](../../util/abstractfactory#notify() "notify"), [notifyAll](../../util/abstractfactory#notifyAll() "notifyAll"), [newInstance](../../util/abstractfactory#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map) "newInstance")` \| Constructor Detail ------------------ ### BoxLayoutFactory() Method Detail ------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) ### void setParent([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child) groovy [Groovy] Class GridBagFactory [Groovy] Class GridBagFactory ============================= * groovy.swing.factory.GridBagFactory ``` class GridBagFactory extends [LayoutFactory](layoutfactory) ``` Inherited fields \| Fields inherited from class \| Fields \| \| `class [LayoutFactory](layoutfactory)` \| `[DEFAULT\_DELEGATE\_PROPERTY\_CONSTRAINT](layoutfactory#DEFAULT_DELEGATE_PROPERTY_CONSTRAINT), [DELEGATE\_PROPERTY\_CONSTRAINT](layoutfactory#DELEGATE_PROPERTY_CONSTRAINT)` \| \| `class [BeanFactory](beanfactory)` \| `[leaf](beanfactory#leaf)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[GridBagFactory](#GridBagFactory())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `void` \| `[addLayoutProperties](#addLayoutProperties(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") context)` \| \| \| `static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[extractAttribute](#extractAttribute(java.util.Map,%20java.lang.String,%20java.lang.Class))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attrs, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") type)` Returns: null if not found. \| \| \| `static void` \| `[processGridBagConstraintsAttributes](#processGridBagConstraintsAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [LayoutFactory](layoutfactory)` \| `[addLayoutProperties](layoutfactory#addLayoutProperties(java.lang.Object,%20java.lang.Class)), [addLayoutProperties](layoutfactory#addLayoutProperties(java.lang.Object)), [constraintsAttributeDelegate](layoutfactory#constraintsAttributeDelegate(java.lang.Object,%20java.lang.Object,%20java.lang.Object)), [getLayoutTarget](layoutfactory#getLayoutTarget(Container)), [newInstance](layoutfactory#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map)), [setParent](layoutfactory#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))` \| \| `class [BeanFactory](beanfactory)` \| `[isLeaf](beanfactory#isLeaf()), [newInstance](beanfactory#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))` \| Constructor Detail ------------------ ### GridBagFactory() Method Detail ------------- ### void addLayoutProperties([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") context) ### static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") extractAttribute([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attrs, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") type) Returns: null if not found. null as a 'not found' works because all attrs except insets are primitive types, and insets will crash if set to null ### static void processGridBagConstraintsAttributes([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) groovy [Groovy] Class ActionFactory [Groovy] Class ActionFactory ============================ * groovy.swing.factory.ActionFactory ``` class ActionFactory extends [AbstractFactory](../../util/abstractfactory "AbstractFactory") ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[ActionFactory](#ActionFactory())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[capitalize](#capitalize(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text)` \| \| \| `boolean` \| `[isHandlesNodeChildren](#isHandlesNodeChildren())()` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| \| \| `boolean` \| `[onHandleNodeAttributes](#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") action, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| \| \| `boolean` \| `[onNodeChildren](#onNodeChildren(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20groovy.lang.Closure))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Closure](../../lang/closure) childContent)` \| \| \| `void` \| `[setParent](#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") action)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractFactory](../../util/abstractfactory "AbstractFactory")` \| `[setParent](../../util/abstractfactory#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setParent"), [isLeaf](../../util/abstractfactory#isLeaf() "isLeaf"), [onNodeChildren](../../util/abstractfactory#onNodeChildren(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20groovy.lang.Closure) "onNodeChildren"), [setChild](../../util/abstractfactory#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setChild"), [onNodeCompleted](../../util/abstractfactory#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "onNodeCompleted"), [onFactoryRegistration](../../util/abstractfactory#onFactoryRegistration(groovy.util.FactoryBuilderSupport,%20java.lang.String,%20java.lang.String) "onFactoryRegistration"), [isHandlesNodeChildren](../../util/abstractfactory#isHandlesNodeChildren() "isHandlesNodeChildren"), [onHandleNodeAttributes](../../util/abstractfactory#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map) "onHandleNodeAttributes"), [wait](../../util/abstractfactory#wait(long,%20int) "wait"), [wait](../../util/abstractfactory#wait() "wait"), [wait](../../util/abstractfactory#wait(long) "wait"), [equals](../../util/abstractfactory#equals(java.lang.Object) "equals"), [toString](../../util/abstractfactory#toString() "toString"), [hashCode](../../util/abstractfactory#hashCode() "hashCode"), [getClass](../../util/abstractfactory#getClass() "getClass"), [notify](../../util/abstractfactory#notify() "notify"), [notifyAll](../../util/abstractfactory#notifyAll() "notifyAll"), [newInstance](../../util/abstractfactory#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map) "newInstance")` \| Constructor Detail ------------------ ### ActionFactory() Method Detail ------------- ### [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") capitalize([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text) ### boolean isHandlesNodeChildren() ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) ### boolean onHandleNodeAttributes([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") action, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) ### boolean onNodeChildren([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Closure](../../lang/closure) childContent) ### void setParent([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") action) groovy [Groovy] Class CellEditorFactory [Groovy] Class CellEditorFactory ================================ * groovy.swing.factory.CellEditorFactory ``` class CellEditorFactory extends [AbstractFactory](../../util/abstractfactory "AbstractFactory") ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[CellEditorFactory](#CellEditorFactory())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| \| \| `void` \| `[onNodeCompleted](#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node)` \| \| \| `void` \| `[setChild](#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractFactory](../../util/abstractfactory "AbstractFactory")` \| `[setParent](../../util/abstractfactory#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setParent"), [isLeaf](../../util/abstractfactory#isLeaf() "isLeaf"), [onNodeChildren](../../util/abstractfactory#onNodeChildren(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20groovy.lang.Closure) "onNodeChildren"), [setChild](../../util/abstractfactory#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setChild"), [onNodeCompleted](../../util/abstractfactory#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "onNodeCompleted"), [onFactoryRegistration](../../util/abstractfactory#onFactoryRegistration(groovy.util.FactoryBuilderSupport,%20java.lang.String,%20java.lang.String) "onFactoryRegistration"), [isHandlesNodeChildren](../../util/abstractfactory#isHandlesNodeChildren() "isHandlesNodeChildren"), [onHandleNodeAttributes](../../util/abstractfactory#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map) "onHandleNodeAttributes"), [wait](../../util/abstractfactory#wait(long,%20int) "wait"), [wait](../../util/abstractfactory#wait() "wait"), [wait](../../util/abstractfactory#wait(long) "wait"), [equals](../../util/abstractfactory#equals(java.lang.Object) "equals"), [toString](../../util/abstractfactory#toString() "toString"), [hashCode](../../util/abstractfactory#hashCode() "hashCode"), [getClass](../../util/abstractfactory#getClass() "getClass"), [notify](../../util/abstractfactory#notify() "notify"), [notifyAll](../../util/abstractfactory#notifyAll() "notifyAll"), [newInstance](../../util/abstractfactory#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map) "newInstance")` \| Constructor Detail ------------------ ### CellEditorFactory() Method Detail ------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) ### void onNodeCompleted([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node) ### void setChild([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child)	programming_docs
groovy [Groovy] Class TitledBorderFactory [Groovy] Class TitledBorderFactory ================================== * groovy.swing.factory.TitledBorderFactory ``` class TitledBorderFactory extends [SwingBorderFactory](swingborderfactory) ``` The node must be called with either a value argument or a title: attribute. The following attributes are optional. position: one of "default", "aboveTop", "top", "belowTop", "aboveBottom", "bottom", "belowBottom", or a constant from javax.swing.border.TitledBorder justification: one of "default", "left", "center", "right", "leading", "trailing", or a constant from javax.swing.border.TitledBorder border: javax.swing.Border, some other border, if unset the look and feel default will be used color: java.awt.Color the color of the text for the title font: java.awt.Font the font of the text for the title Properties Summary ------------------ Properties \| Type \| Name and description \| \| `static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")` \| `[justifications](#justifications)` \| \| `static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")` \| `[positions](#positions)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[TitledBorderFactory](#TitledBorderFactory())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [SwingBorderFactory](swingborderfactory)` \| `[isLeaf](swingborderfactory#isLeaf()), [onHandleNodeAttributes](swingborderfactory#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map)), [setParent](swingborderfactory#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))` \| Property Detail --------------- ### static final [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") justifications ### static final [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") positions Constructor Detail ------------------ ### TitledBorderFactory() Method Detail ------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) groovy [Groovy] Class MatteBorderFactory [Groovy] Class MatteBorderFactory ================================= * groovy.swing.factory.MatteBorderFactory ``` class MatteBorderFactory extends [SwingBorderFactory](swingborderfactory) ``` matteBorder requires essentially two parameter, a mat definition and a border size definition. The value argument can accept either of these: any of a java.awt.Color, a javax.swing.Icon, an integer, or a 4 arg integer array. The remaining parameter must be define via attributes, either an icon: or color: attribute and a size: or top:, left:, bottom:, and right: attribute. Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[MatteBorderFactory](#MatteBorderFactory())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [SwingBorderFactory](swingborderfactory)` \| `[isLeaf](swingborderfactory#isLeaf()), [onHandleNodeAttributes](swingborderfactory#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map)), [setParent](swingborderfactory#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))` \| Constructor Detail ------------------ ### MatteBorderFactory() Method Detail ------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) groovy [Groovy] Class LayoutFactory [Groovy] Class LayoutFactory ============================ * groovy.swing.factory.LayoutFactory ``` class LayoutFactory extends [BeanFactory](beanfactory) ``` Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DEFAULT\_DELEGATE\_PROPERTY\_CONSTRAINT](#DEFAULT_DELEGATE_PROPERTY_CONSTRAINT)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DELEGATE\_PROPERTY\_CONSTRAINT](#DELEGATE_PROPERTY_CONSTRAINT)` \| \| Inherited fields \| Fields inherited from class \| Fields \| \| `class [BeanFactory](beanfactory)` \| `[leaf](beanfactory#leaf)` \| Properties Summary ------------------ Properties \| Type \| Name and description \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[contextProps](#contextProps)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[LayoutFactory](#LayoutFactory(java.lang.Class))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") klass)` \| \| `[LayoutFactory](#LayoutFactory(java.lang.Class,%20boolean))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") klass, boolean leaf)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `void` \| `[addLayoutProperties](#addLayoutProperties(java.lang.Object,%20java.lang.Class))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") context, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") layoutClass)` \| \| \| `void` \| `[addLayoutProperties](#addLayoutProperties(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") context)` \| \| \| `static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[constraintsAttributeDelegate](#constraintsAttributeDelegate(java.lang.Object,%20java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") attributes)` \| \| \| `static [Container](../../../container)` \| `[getLayoutTarget](#getLayoutTarget(Container))([Container](../../../container) parent)` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| \| \| `void` \| `[setParent](#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [BeanFactory](beanfactory)` \| `[isLeaf](beanfactory#isLeaf()), [newInstance](beanfactory#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))` \| Field Detail ------------ ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DEFAULT\_DELEGATE\_PROPERTY\_CONSTRAINT ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DELEGATE\_PROPERTY\_CONSTRAINT Property Detail --------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") contextProps Constructor Detail ------------------ ### LayoutFactory([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") klass) ### LayoutFactory([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") klass, boolean leaf) Method Detail ------------- ### void addLayoutProperties([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") context, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") layoutClass) ### void addLayoutProperties([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") context) ### static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") constraintsAttributeDelegate([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") attributes) ### static [Container](../../../container) getLayoutTarget([Container](../../../container) parent) ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) ### void setParent([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child) groovy [Groovy] Class ComboBoxFactory [Groovy] Class ComboBoxFactory ============================== * groovy.swing.factory.ComboBoxFactory ``` class ComboBoxFactory extends [AbstractFactory](../../util/abstractfactory "AbstractFactory") ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[ComboBoxFactory](#ComboBoxFactory())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractFactory](../../util/abstractfactory "AbstractFactory")` \| `[setParent](../../util/abstractfactory#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setParent"), [isLeaf](../../util/abstractfactory#isLeaf() "isLeaf"), [onNodeChildren](../../util/abstractfactory#onNodeChildren(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20groovy.lang.Closure) "onNodeChildren"), [setChild](../../util/abstractfactory#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setChild"), [onNodeCompleted](../../util/abstractfactory#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "onNodeCompleted"), [onFactoryRegistration](../../util/abstractfactory#onFactoryRegistration(groovy.util.FactoryBuilderSupport,%20java.lang.String,%20java.lang.String) "onFactoryRegistration"), [isHandlesNodeChildren](../../util/abstractfactory#isHandlesNodeChildren() "isHandlesNodeChildren"), [onHandleNodeAttributes](../../util/abstractfactory#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map) "onHandleNodeAttributes"), [wait](../../util/abstractfactory#wait(long,%20int) "wait"), [wait](../../util/abstractfactory#wait() "wait"), [wait](../../util/abstractfactory#wait(long) "wait"), [equals](../../util/abstractfactory#equals(java.lang.Object) "equals"), [toString](../../util/abstractfactory#toString() "toString"), [hashCode](../../util/abstractfactory#hashCode() "hashCode"), [getClass](../../util/abstractfactory#getClass() "getClass"), [notify](../../util/abstractfactory#notify() "notify"), [notifyAll](../../util/abstractfactory#notifyAll() "notifyAll"), [newInstance](../../util/abstractfactory#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map) "newInstance")` \| Constructor Detail ------------------ ### ComboBoxFactory() Method Detail ------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) groovy [Groovy] Class ColumnModelFactory [Groovy] Class ColumnModelFactory ================================= * groovy.swing.factory.ColumnModelFactory ``` @[Log](../../util/logging/log "Log") class ColumnModelFactory extends [AbstractFactory](../../util/abstractfactory "AbstractFactory") ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[ColumnModelFactory](#ColumnModelFactory())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| \| \| `void` \| `[onNodeCompleted](#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractFactory](../../util/abstractfactory "AbstractFactory")` \| `[setParent](../../util/abstractfactory#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setParent"), [isLeaf](../../util/abstractfactory#isLeaf() "isLeaf"), [onNodeChildren](../../util/abstractfactory#onNodeChildren(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20groovy.lang.Closure) "onNodeChildren"), [setChild](../../util/abstractfactory#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setChild"), [onNodeCompleted](../../util/abstractfactory#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "onNodeCompleted"), [onFactoryRegistration](../../util/abstractfactory#onFactoryRegistration(groovy.util.FactoryBuilderSupport,%20java.lang.String,%20java.lang.String) "onFactoryRegistration"), [isHandlesNodeChildren](../../util/abstractfactory#isHandlesNodeChildren() "isHandlesNodeChildren"), [onHandleNodeAttributes](../../util/abstractfactory#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map) "onHandleNodeAttributes"), [wait](../../util/abstractfactory#wait(long,%20int) "wait"), [wait](../../util/abstractfactory#wait() "wait"), [wait](../../util/abstractfactory#wait(long) "wait"), [equals](../../util/abstractfactory#equals(java.lang.Object) "equals"), [toString](../../util/abstractfactory#toString() "toString"), [hashCode](../../util/abstractfactory#hashCode() "hashCode"), [getClass](../../util/abstractfactory#getClass() "getClass"), [notify](../../util/abstractfactory#notify() "notify"), [notifyAll](../../util/abstractfactory#notifyAll() "notifyAll"), [newInstance](../../util/abstractfactory#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map) "newInstance")` \| Constructor Detail ------------------ ### ColumnModelFactory() Method Detail ------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) ### void onNodeCompleted([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node) groovy [Groovy] Class CollectionFactory [Groovy] Class CollectionFactory ================================ * groovy.swing.factory.CollectionFactory ``` class CollectionFactory extends [AbstractFactory](../../util/abstractfactory "AbstractFactory") ``` This returns a mutable java.util.Collection of some sort, to which items are added. Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[CollectionFactory](#CollectionFactory())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| \| \| `void` \| `[setChild](#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractFactory](../../util/abstractfactory "AbstractFactory")` \| `[setParent](../../util/abstractfactory#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setParent"), [isLeaf](../../util/abstractfactory#isLeaf() "isLeaf"), [onNodeChildren](../../util/abstractfactory#onNodeChildren(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20groovy.lang.Closure) "onNodeChildren"), [setChild](../../util/abstractfactory#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setChild"), [onNodeCompleted](../../util/abstractfactory#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "onNodeCompleted"), [onFactoryRegistration](../../util/abstractfactory#onFactoryRegistration(groovy.util.FactoryBuilderSupport,%20java.lang.String,%20java.lang.String) "onFactoryRegistration"), [isHandlesNodeChildren](../../util/abstractfactory#isHandlesNodeChildren() "isHandlesNodeChildren"), [onHandleNodeAttributes](../../util/abstractfactory#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map) "onHandleNodeAttributes"), [wait](../../util/abstractfactory#wait(long,%20int) "wait"), [wait](../../util/abstractfactory#wait() "wait"), [wait](../../util/abstractfactory#wait(long) "wait"), [equals](../../util/abstractfactory#equals(java.lang.Object) "equals"), [toString](../../util/abstractfactory#toString() "toString"), [hashCode](../../util/abstractfactory#hashCode() "hashCode"), [getClass](../../util/abstractfactory#getClass() "getClass"), [notify](../../util/abstractfactory#notify() "notify"), [notifyAll](../../util/abstractfactory#notifyAll() "notifyAll"), [newInstance](../../util/abstractfactory#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map) "newInstance")` \| Constructor Detail ------------------ ### CollectionFactory() Method Detail ------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) ### void setChild([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child)	programming_docs
groovy [Groovy] Class TabbedPaneFactory [Groovy] Class TabbedPaneFactory ================================ * groovy.swing.factory.TabbedPaneFactory ``` class TabbedPaneFactory extends [BeanFactory](beanfactory) ``` Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[CONTEXT\_DATA\_KEY](#CONTEXT_DATA_KEY)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DEFAULT\_DELEGATE\_PROPERTY\_TAB\_BACKGROUND](#DEFAULT_DELEGATE_PROPERTY_TAB_BACKGROUND)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DEFAULT\_DELEGATE\_PROPERTY\_TAB\_DISABLED\_ICON](#DEFAULT_DELEGATE_PROPERTY_TAB_DISABLED_ICON)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DEFAULT\_DELEGATE\_PROPERTY\_TAB\_DISPLAYED\_MNEMONIC\_INDEX](#DEFAULT_DELEGATE_PROPERTY_TAB_DISPLAYED_MNEMONIC_INDEX)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DEFAULT\_DELEGATE\_PROPERTY\_TAB\_ENABLED](#DEFAULT_DELEGATE_PROPERTY_TAB_ENABLED)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DEFAULT\_DELEGATE\_PROPERTY\_TAB\_FOREGROUND](#DEFAULT_DELEGATE_PROPERTY_TAB_FOREGROUND)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DEFAULT\_DELEGATE\_PROPERTY\_TAB\_ICON](#DEFAULT_DELEGATE_PROPERTY_TAB_ICON)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DEFAULT\_DELEGATE\_PROPERTY\_TAB\_MNEMONIC](#DEFAULT_DELEGATE_PROPERTY_TAB_MNEMONIC)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DEFAULT\_DELEGATE\_PROPERTY\_TAB\_TOOL\_TIP](#DEFAULT_DELEGATE_PROPERTY_TAB_TOOL_TIP)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DEFAULT\_DELEGATE\_PROPERTY\_TITLE](#DEFAULT_DELEGATE_PROPERTY_TITLE)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DELEGATE\_PROPERTY\_TAB\_BACKGROUND](#DELEGATE_PROPERTY_TAB_BACKGROUND)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DELEGATE\_PROPERTY\_TAB\_DISABLED\_ICON](#DELEGATE_PROPERTY_TAB_DISABLED_ICON)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DELEGATE\_PROPERTY\_TAB\_DISPLAYED\_MNEMONIC\_INDEX](#DELEGATE_PROPERTY_TAB_DISPLAYED_MNEMONIC_INDEX)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DELEGATE\_PROPERTY\_TAB\_ENABLED](#DELEGATE_PROPERTY_TAB_ENABLED)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DELEGATE\_PROPERTY\_TAB\_FOREGROUND](#DELEGATE_PROPERTY_TAB_FOREGROUND)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DELEGATE\_PROPERTY\_TAB\_ICON](#DELEGATE_PROPERTY_TAB_ICON)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DELEGATE\_PROPERTY\_TAB\_MNEMONIC](#DELEGATE_PROPERTY_TAB_MNEMONIC)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DELEGATE\_PROPERTY\_TAB\_TOOL\_TIP](#DELEGATE_PROPERTY_TAB_TOOL_TIP)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DELEGATE\_PROPERTY\_TITLE](#DELEGATE_PROPERTY_TITLE)` \| \| Inherited fields \| Fields inherited from class \| Fields \| \| `class [BeanFactory](beanfactory)` \| `[leaf](beanfactory#leaf)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[TabbedPaneFactory](#TabbedPaneFactory(java.lang.Class))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") beanClass)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `static void` \| `[inspectChild](#inspectChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| \| \| `void` \| `[onNodeCompleted](#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node)` \| \| \| `void` \| `[setChild](#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [BeanFactory](beanfactory)` \| `[isLeaf](beanfactory#isLeaf()), [newInstance](beanfactory#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))` \| Field Detail ------------ ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") CONTEXT\_DATA\_KEY ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DEFAULT\_DELEGATE\_PROPERTY\_TAB\_BACKGROUND ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DEFAULT\_DELEGATE\_PROPERTY\_TAB\_DISABLED\_ICON ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DEFAULT\_DELEGATE\_PROPERTY\_TAB\_DISPLAYED\_MNEMONIC\_INDEX ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DEFAULT\_DELEGATE\_PROPERTY\_TAB\_ENABLED ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DEFAULT\_DELEGATE\_PROPERTY\_TAB\_FOREGROUND ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DEFAULT\_DELEGATE\_PROPERTY\_TAB\_ICON ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DEFAULT\_DELEGATE\_PROPERTY\_TAB\_MNEMONIC ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DEFAULT\_DELEGATE\_PROPERTY\_TAB\_TOOL\_TIP ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DEFAULT\_DELEGATE\_PROPERTY\_TITLE ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DELEGATE\_PROPERTY\_TAB\_BACKGROUND ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DELEGATE\_PROPERTY\_TAB\_DISABLED\_ICON ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DELEGATE\_PROPERTY\_TAB\_DISPLAYED\_MNEMONIC\_INDEX ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DELEGATE\_PROPERTY\_TAB\_ENABLED ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DELEGATE\_PROPERTY\_TAB\_FOREGROUND ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DELEGATE\_PROPERTY\_TAB\_ICON ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DELEGATE\_PROPERTY\_TAB\_MNEMONIC ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DELEGATE\_PROPERTY\_TAB\_TOOL\_TIP ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DELEGATE\_PROPERTY\_TITLE Constructor Detail ------------------ ### TabbedPaneFactory([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") beanClass) Method Detail ------------- ### static void inspectChild([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) ### void onNodeCompleted([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node) ### void setChild([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child) groovy [Groovy] Class BindProxyFactory [Groovy] Class BindProxyFactory =============================== * groovy.swing.factory.BindProxyFactory ``` class BindProxyFactory extends [AbstractFactory](../../util/abstractfactory "AbstractFactory") ``` Since: Groovy 1.1 Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[BindProxyFactory](#BindProxyFactory())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `boolean` \| `[isLeaf](#isLeaf())()` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| \| \| `void` \| `[onNodeCompleted](#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractFactory](../../util/abstractfactory "AbstractFactory")` \| `[setParent](../../util/abstractfactory#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setParent"), [isLeaf](../../util/abstractfactory#isLeaf() "isLeaf"), [onNodeChildren](../../util/abstractfactory#onNodeChildren(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20groovy.lang.Closure) "onNodeChildren"), [setChild](../../util/abstractfactory#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setChild"), [onNodeCompleted](../../util/abstractfactory#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "onNodeCompleted"), [onFactoryRegistration](../../util/abstractfactory#onFactoryRegistration(groovy.util.FactoryBuilderSupport,%20java.lang.String,%20java.lang.String) "onFactoryRegistration"), [isHandlesNodeChildren](../../util/abstractfactory#isHandlesNodeChildren() "isHandlesNodeChildren"), [onHandleNodeAttributes](../../util/abstractfactory#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map) "onHandleNodeAttributes"), [wait](../../util/abstractfactory#wait(long,%20int) "wait"), [wait](../../util/abstractfactory#wait() "wait"), [wait](../../util/abstractfactory#wait(long) "wait"), [equals](../../util/abstractfactory#equals(java.lang.Object) "equals"), [toString](../../util/abstractfactory#toString() "toString"), [hashCode](../../util/abstractfactory#hashCode() "hashCode"), [getClass](../../util/abstractfactory#getClass() "getClass"), [notify](../../util/abstractfactory#notify() "notify"), [notifyAll](../../util/abstractfactory#notifyAll() "notifyAll"), [newInstance](../../util/abstractfactory#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map) "newInstance")` \| Constructor Detail ------------------ ### BindProxyFactory() Method Detail ------------- ### boolean isLeaf() ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) ### void onNodeCompleted([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node) groovy [Groovy] Class EtchedBorderFactory [Groovy] Class EtchedBorderFactory ================================== * groovy.swing.factory.EtchedBorderFactory ``` class EtchedBorderFactory extends [SwingBorderFactory](swingborderfactory) ``` Properties Summary ------------------ Properties \| Type \| Name and description \| \| `int` \| `[type](#type)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[EtchedBorderFactory](#EtchedBorderFactory(int))(int newType)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [SwingBorderFactory](swingborderfactory)` \| `[isLeaf](swingborderfactory#isLeaf()), [onHandleNodeAttributes](swingborderfactory#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map)), [setParent](swingborderfactory#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))` \| Property Detail --------------- ### final int type Constructor Detail ------------------ ### EtchedBorderFactory(int newType) Method Detail ------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) groovy [Groovy] Class TextArgWidgetFactory [Groovy] Class TextArgWidgetFactory =================================== * groovy.swing.factory.TextArgWidgetFactory ``` class TextArgWidgetFactory extends [AbstractFactory](../../util/abstractfactory "AbstractFactory") ``` Properties Summary ------------------ Properties \| Type \| Name and description \| \| `[Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")` \| `[klass](#klass)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[TextArgWidgetFactory](#TextArgWidgetFactory(java.lang.Class))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") klass)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractFactory](../../util/abstractfactory "AbstractFactory")` \| `[setParent](../../util/abstractfactory#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setParent"), [isLeaf](../../util/abstractfactory#isLeaf() "isLeaf"), [onNodeChildren](../../util/abstractfactory#onNodeChildren(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20groovy.lang.Closure) "onNodeChildren"), [setChild](../../util/abstractfactory#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setChild"), [onNodeCompleted](../../util/abstractfactory#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "onNodeCompleted"), [onFactoryRegistration](../../util/abstractfactory#onFactoryRegistration(groovy.util.FactoryBuilderSupport,%20java.lang.String,%20java.lang.String) "onFactoryRegistration"), [isHandlesNodeChildren](../../util/abstractfactory#isHandlesNodeChildren() "isHandlesNodeChildren"), [onHandleNodeAttributes](../../util/abstractfactory#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map) "onHandleNodeAttributes"), [wait](../../util/abstractfactory#wait(long,%20int) "wait"), [wait](../../util/abstractfactory#wait() "wait"), [wait](../../util/abstractfactory#wait(long) "wait"), [equals](../../util/abstractfactory#equals(java.lang.Object) "equals"), [toString](../../util/abstractfactory#toString() "toString"), [hashCode](../../util/abstractfactory#hashCode() "hashCode"), [getClass](../../util/abstractfactory#getClass() "getClass"), [notify](../../util/abstractfactory#notify() "notify"), [notifyAll](../../util/abstractfactory#notifyAll() "notifyAll"), [newInstance](../../util/abstractfactory#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map) "newInstance")` \| Property Detail --------------- ### final [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") klass Constructor Detail ------------------ ### TextArgWidgetFactory([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") klass) Method Detail ------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)	programming_docs
groovy [Groovy] Class SwingBorderFactory [Groovy] Class SwingBorderFactory ================================= * groovy.swing.factory.SwingBorderFactory ``` abstract class SwingBorderFactory extends [AbstractFactory](../../util/abstractfactory "AbstractFactory") ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[SwingBorderFactory](#SwingBorderFactory())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `boolean` \| `[isLeaf](#isLeaf())()` \| \| \| `boolean` \| `[onHandleNodeAttributes](#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| \| \| `void` \| `[setParent](#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractFactory](../../util/abstractfactory "AbstractFactory")` \| `[setParent](../../util/abstractfactory#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setParent"), [isLeaf](../../util/abstractfactory#isLeaf() "isLeaf"), [onNodeChildren](../../util/abstractfactory#onNodeChildren(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20groovy.lang.Closure) "onNodeChildren"), [setChild](../../util/abstractfactory#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setChild"), [onNodeCompleted](../../util/abstractfactory#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "onNodeCompleted"), [onFactoryRegistration](../../util/abstractfactory#onFactoryRegistration(groovy.util.FactoryBuilderSupport,%20java.lang.String,%20java.lang.String) "onFactoryRegistration"), [isHandlesNodeChildren](../../util/abstractfactory#isHandlesNodeChildren() "isHandlesNodeChildren"), [onHandleNodeAttributes](../../util/abstractfactory#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map) "onHandleNodeAttributes"), [wait](../../util/abstractfactory#wait(long,%20int) "wait"), [wait](../../util/abstractfactory#wait() "wait"), [wait](../../util/abstractfactory#wait(long) "wait"), [equals](../../util/abstractfactory#equals(java.lang.Object) "equals"), [toString](../../util/abstractfactory#toString() "toString"), [hashCode](../../util/abstractfactory#hashCode() "hashCode"), [getClass](../../util/abstractfactory#getClass() "getClass"), [notify](../../util/abstractfactory#notify() "notify"), [notifyAll](../../util/abstractfactory#notifyAll() "notifyAll"), [newInstance](../../util/abstractfactory#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map) "newInstance")` \| Constructor Detail ------------------ ### SwingBorderFactory() Method Detail ------------- ### boolean isLeaf() ### boolean onHandleNodeAttributes([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) ### void setParent([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child) groovy [Groovy] Class ButtonGroupFactory [Groovy] Class ButtonGroupFactory ================================= * groovy.swing.factory.ButtonGroupFactory ``` class ButtonGroupFactory extends [BeanFactory](beanfactory) ``` Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DEFAULT\_DELEGATE\_PROPERTY\_BUTTON\_GROUP](#DEFAULT_DELEGATE_PROPERTY_BUTTON_GROUP)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DELEGATE\_PROPERTY\_BUTTON\_GROUP](#DELEGATE_PROPERTY_BUTTON_GROUP)` \| \| Inherited fields \| Fields inherited from class \| Fields \| \| `class [BeanFactory](beanfactory)` \| `[leaf](beanfactory#leaf)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[ButtonGroupFactory](#ButtonGroupFactory())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[buttonGroupAttributeDelegate](#buttonGroupAttributeDelegate(java.lang.Object,%20java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") attributes)` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [BeanFactory](beanfactory)` \| `[isLeaf](beanfactory#isLeaf()), [newInstance](beanfactory#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))` \| Field Detail ------------ ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DEFAULT\_DELEGATE\_PROPERTY\_BUTTON\_GROUP ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DELEGATE\_PROPERTY\_BUTTON\_GROUP Constructor Detail ------------------ ### ButtonGroupFactory() Method Detail ------------- ### static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") buttonGroupAttributeDelegate([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") attributes) ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) groovy [Groovy] Class BoxFactory [Groovy] Class BoxFactory ========================= * groovy.swing.factory.BoxFactory ``` class BoxFactory extends [ComponentFactory](componentfactory) ``` Inherited fields \| Fields inherited from class \| Fields \| \| `class [BeanFactory](beanfactory)` \| `[leaf](beanfactory#leaf)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[BoxFactory](#BoxFactory())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [ComponentFactory](componentfactory)` \| `[setChild](componentfactory#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))` \| \| `class [BeanFactory](beanfactory)` \| `[isLeaf](beanfactory#isLeaf()), [newInstance](beanfactory#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))` \| Constructor Detail ------------------ ### BoxFactory() Method Detail ------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) groovy [Groovy] Class LineBorderFactory [Groovy] Class LineBorderFactory ================================ * groovy.swing.factory.LineBorderFactory ``` class LineBorderFactory extends [SwingBorderFactory](swingborderfactory) ``` accepts attributes: color: java.awt.Color color: java.awt.Color, thickness: int color: java.awt.Color, thickness: int, roundedBorders: boolean Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[LineBorderFactory](#LineBorderFactory())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [SwingBorderFactory](swingborderfactory)` \| `[isLeaf](swingborderfactory#isLeaf()), [onHandleNodeAttributes](swingborderfactory#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map)), [setParent](swingborderfactory#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))` \| Constructor Detail ------------------ ### LineBorderFactory() Method Detail ------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) groovy [Groovy] Class RootPaneContainerFactory [Groovy] Class RootPaneContainerFactory ======================================= * groovy.swing.factory.RootPaneContainerFactory ``` abstract class RootPaneContainerFactory extends [AbstractFactory](../../util/abstractfactory "AbstractFactory") ``` Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DEFAULT\_DELEGATE\_PROPERTY\_DEFAULT\_BUTTON](#DEFAULT_DELEGATE_PROPERTY_DEFAULT_BUTTON)` \| \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[DELEGATE\_PROPERTY\_DEFAULT\_BUTTON](#DELEGATE_PROPERTY_DEFAULT_BUTTON)` \| \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[RootPaneContainerFactory](#RootPaneContainerFactory())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `void` \| `[handleRootPaneTasks](#handleRootPaneTasks(groovy.util.FactoryBuilderSupport,%20java.awt.Window,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Window](https://docs.oracle.com/javase/8/docs/api/java/awt/Window.html "Window") container, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| \| \| `void` \| `[onNodeCompleted](#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node)` \| \| \| `void` \| `[setChild](#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractFactory](../../util/abstractfactory "AbstractFactory")` \| `[setParent](../../util/abstractfactory#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setParent"), [isLeaf](../../util/abstractfactory#isLeaf() "isLeaf"), [onNodeChildren](../../util/abstractfactory#onNodeChildren(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20groovy.lang.Closure) "onNodeChildren"), [setChild](../../util/abstractfactory#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setChild"), [onNodeCompleted](../../util/abstractfactory#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "onNodeCompleted"), [onFactoryRegistration](../../util/abstractfactory#onFactoryRegistration(groovy.util.FactoryBuilderSupport,%20java.lang.String,%20java.lang.String) "onFactoryRegistration"), [isHandlesNodeChildren](../../util/abstractfactory#isHandlesNodeChildren() "isHandlesNodeChildren"), [onHandleNodeAttributes](../../util/abstractfactory#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map) "onHandleNodeAttributes"), [wait](../../util/abstractfactory#wait(long,%20int) "wait"), [wait](../../util/abstractfactory#wait() "wait"), [wait](../../util/abstractfactory#wait(long) "wait"), [equals](../../util/abstractfactory#equals(java.lang.Object) "equals"), [toString](../../util/abstractfactory#toString() "toString"), [hashCode](../../util/abstractfactory#hashCode() "hashCode"), [getClass](../../util/abstractfactory#getClass() "getClass"), [notify](../../util/abstractfactory#notify() "notify"), [notifyAll](../../util/abstractfactory#notifyAll() "notifyAll"), [newInstance](../../util/abstractfactory#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map) "newInstance")` \| Field Detail ------------ ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DEFAULT\_DELEGATE\_PROPERTY\_DEFAULT\_BUTTON ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") DELEGATE\_PROPERTY\_DEFAULT\_BUTTON Constructor Detail ------------------ ### RootPaneContainerFactory() Method Detail ------------- ### void handleRootPaneTasks([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Window](https://docs.oracle.com/javase/8/docs/api/java/awt/Window.html "Window") container, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) ### void onNodeCompleted([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node) ### void setChild([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child) groovy [Groovy] Class DialogFactory [Groovy] Class DialogFactory ============================ * groovy.swing.factory.DialogFactory ``` class DialogFactory extends [RootPaneContainerFactory](rootpanecontainerfactory) ``` Inherited fields \| Fields inherited from class \| Fields \| \| `class [RootPaneContainerFactory](rootpanecontainerfactory)` \| `[DEFAULT\_DELEGATE\_PROPERTY\_DEFAULT\_BUTTON](rootpanecontainerfactory#DEFAULT_DELEGATE_PROPERTY_DEFAULT_BUTTON), [DELEGATE\_PROPERTY\_DEFAULT\_BUTTON](rootpanecontainerfactory#DELEGATE_PROPERTY_DEFAULT_BUTTON)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[DialogFactory](#DialogFactory())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [RootPaneContainerFactory](rootpanecontainerfactory)` \| `[handleRootPaneTasks](rootpanecontainerfactory#handleRootPaneTasks(groovy.util.FactoryBuilderSupport,%20java.awt.Window,%20java.util.Map)), [onNodeCompleted](rootpanecontainerfactory#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object)), [setChild](rootpanecontainerfactory#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))` \| Constructor Detail ------------------ ### DialogFactory() Method Detail ------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) groovy [Groovy] Class WindowFactory [Groovy] Class WindowFactory ============================ * groovy.swing.factory.WindowFactory ``` class WindowFactory extends [RootPaneContainerFactory](rootpanecontainerfactory) ``` Inherited fields \| Fields inherited from class \| Fields \| \| `class [RootPaneContainerFactory](rootpanecontainerfactory)` \| `[DEFAULT\_DELEGATE\_PROPERTY\_DEFAULT\_BUTTON](rootpanecontainerfactory#DEFAULT_DELEGATE_PROPERTY_DEFAULT_BUTTON), [DELEGATE\_PROPERTY\_DEFAULT\_BUTTON](rootpanecontainerfactory#DELEGATE_PROPERTY_DEFAULT_BUTTON)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[WindowFactory](#WindowFactory())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [RootPaneContainerFactory](rootpanecontainerfactory)` \| `[handleRootPaneTasks](rootpanecontainerfactory#handleRootPaneTasks(groovy.util.FactoryBuilderSupport,%20java.awt.Window,%20java.util.Map)), [onNodeCompleted](rootpanecontainerfactory#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object)), [setChild](rootpanecontainerfactory#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))` \| Constructor Detail ------------------ ### WindowFactory() Method Detail ------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)	programming_docs
groovy [Groovy] Class BindFactory [Groovy] Class BindFactory ========================== * groovy.swing.factory.BindFactory ``` class BindFactory extends [AbstractFactory](../../util/abstractfactory "AbstractFactory") ``` Since: Groovy 1.1 Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[CONTEXT\_DATA\_KEY](#CONTEXT_DATA_KEY)` \| \| Properties Summary ------------------ Properties \| Type \| Name and description \| \| `[Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), TriggerBinding>` \| `[syntheticBindings](#syntheticBindings)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[BindFactory](#BindFactory())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[bindingAttributeDelegate](#bindingAttributeDelegate(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") attributes)` \| \| \| `[TriggerBinding](../../../org/apache/groovy/swing/binding/triggerbinding)` \| `[getTriggerBinding](#getTriggerBinding(org.apache.groovy.swing.binding.PropertyBinding))([PropertyBinding](../../../org/apache/groovy/swing/binding/propertybinding) psb)` \| \| \| `boolean` \| `[isHandlesNodeChildren](#isHandlesNodeChildren())()` \| \| \| `boolean` \| `[isLeaf](#isLeaf())()` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)`Accepted Properties... \| \| \| `boolean` \| `[onHandleNodeAttributes](#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| \| \| `boolean` \| `[onNodeChildren](#onNodeChildren(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20groovy.lang.Closure))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Closure](../../lang/closure) childContent)` \| \| \| `void` \| `[onNodeCompleted](#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractFactory](../../util/abstractfactory "AbstractFactory")` \| `[setParent](../../util/abstractfactory#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setParent"), [isLeaf](../../util/abstractfactory#isLeaf() "isLeaf"), [onNodeChildren](../../util/abstractfactory#onNodeChildren(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20groovy.lang.Closure) "onNodeChildren"), [setChild](../../util/abstractfactory#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setChild"), [onNodeCompleted](../../util/abstractfactory#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "onNodeCompleted"), [onFactoryRegistration](../../util/abstractfactory#onFactoryRegistration(groovy.util.FactoryBuilderSupport,%20java.lang.String,%20java.lang.String) "onFactoryRegistration"), [isHandlesNodeChildren](../../util/abstractfactory#isHandlesNodeChildren() "isHandlesNodeChildren"), [onHandleNodeAttributes](../../util/abstractfactory#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map) "onHandleNodeAttributes"), [wait](../../util/abstractfactory#wait(long,%20int) "wait"), [wait](../../util/abstractfactory#wait() "wait"), [wait](../../util/abstractfactory#wait(long) "wait"), [equals](../../util/abstractfactory#equals(java.lang.Object) "equals"), [toString](../../util/abstractfactory#toString() "toString"), [hashCode](../../util/abstractfactory#hashCode() "hashCode"), [getClass](../../util/abstractfactory#getClass() "getClass"), [notify](../../util/abstractfactory#notify() "notify"), [notifyAll](../../util/abstractfactory#notifyAll() "notifyAll"), [newInstance](../../util/abstractfactory#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map) "newInstance")` \| Field Detail ------------ ### public static final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") CONTEXT\_DATA\_KEY Property Detail --------------- ### final [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), TriggerBinding> syntheticBindings Constructor Detail ------------------ ### BindFactory() Method Detail ------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") bindingAttributeDelegate([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") attributes) ### [TriggerBinding](../../../org/apache/groovy/swing/binding/triggerbinding) getTriggerBinding([PropertyBinding](../../../org/apache/groovy/swing/binding/propertybinding) psb) ### boolean isHandlesNodeChildren() ### boolean isLeaf() ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) Accepted Properties... group? source ((sourceProperty) \| (sourceEvent sourceValue)) (target targetProperty)? (? use default javabeans property if targetProperty is not present?) throws: InstantiationException throws: IllegalAccessException Parameters: builder name value attributes Returns: the newly created instance ### boolean onHandleNodeAttributes([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) ### boolean onNodeChildren([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node, [Closure](../../lang/closure) childContent) ### void onNodeCompleted([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node) groovy [Groovy] Class TableModelFactory [Groovy] Class TableModelFactory ================================ * groovy.swing.factory.TableModelFactory ``` class TableModelFactory extends [AbstractFactory](../../util/abstractfactory "AbstractFactory") ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[TableModelFactory](#TableModelFactory())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| \| \| `void` \| `[onNodeCompleted](#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractFactory](../../util/abstractfactory "AbstractFactory")` \| `[setParent](../../util/abstractfactory#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setParent"), [isLeaf](../../util/abstractfactory#isLeaf() "isLeaf"), [onNodeChildren](../../util/abstractfactory#onNodeChildren(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20groovy.lang.Closure) "onNodeChildren"), [setChild](../../util/abstractfactory#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setChild"), [onNodeCompleted](../../util/abstractfactory#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "onNodeCompleted"), [onFactoryRegistration](../../util/abstractfactory#onFactoryRegistration(groovy.util.FactoryBuilderSupport,%20java.lang.String,%20java.lang.String) "onFactoryRegistration"), [isHandlesNodeChildren](../../util/abstractfactory#isHandlesNodeChildren() "isHandlesNodeChildren"), [onHandleNodeAttributes](../../util/abstractfactory#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map) "onHandleNodeAttributes"), [wait](../../util/abstractfactory#wait(long,%20int) "wait"), [wait](../../util/abstractfactory#wait() "wait"), [wait](../../util/abstractfactory#wait(long) "wait"), [equals](../../util/abstractfactory#equals(java.lang.Object) "equals"), [toString](../../util/abstractfactory#toString() "toString"), [hashCode](../../util/abstractfactory#hashCode() "hashCode"), [getClass](../../util/abstractfactory#getClass() "getClass"), [notify](../../util/abstractfactory#notify() "notify"), [notifyAll](../../util/abstractfactory#notifyAll() "notifyAll"), [newInstance](../../util/abstractfactory#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map) "newInstance")` \| Constructor Detail ------------------ ### TableModelFactory() Method Detail ------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) ### void onNodeCompleted([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node) groovy [Groovy] Class EmptyBorderFactory [Groovy] Class EmptyBorderFactory ================================= * groovy.swing.factory.EmptyBorderFactory ``` class EmptyBorderFactory extends [SwingBorderFactory](swingborderfactory) ``` accepts values in lieu of attributes: int - all of top, left, bottom, right [int, int, int, int] - top, left, bottom, right accepts attributes when no value present: top: int, left: int, bottom: int, right: int Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[EmptyBorderFactory](#EmptyBorderFactory())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [SwingBorderFactory](swingborderfactory)` \| `[isLeaf](swingborderfactory#isLeaf()), [onHandleNodeAttributes](swingborderfactory#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map)), [setParent](swingborderfactory#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))` \| Constructor Detail ------------------ ### EmptyBorderFactory() Method Detail ------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) groovy [Groovy] Class ImageIconFactory [Groovy] Class ImageIconFactory =============================== * groovy.swing.factory.ImageIconFactory ``` class ImageIconFactory extends [AbstractFactory](../../util/abstractfactory "AbstractFactory") ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[ImageIconFactory](#ImageIconFactory())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractFactory](../../util/abstractfactory "AbstractFactory")` \| `[setParent](../../util/abstractfactory#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setParent"), [isLeaf](../../util/abstractfactory#isLeaf() "isLeaf"), [onNodeChildren](../../util/abstractfactory#onNodeChildren(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20groovy.lang.Closure) "onNodeChildren"), [setChild](../../util/abstractfactory#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setChild"), [onNodeCompleted](../../util/abstractfactory#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "onNodeCompleted"), [onFactoryRegistration](../../util/abstractfactory#onFactoryRegistration(groovy.util.FactoryBuilderSupport,%20java.lang.String,%20java.lang.String) "onFactoryRegistration"), [isHandlesNodeChildren](../../util/abstractfactory#isHandlesNodeChildren() "isHandlesNodeChildren"), [onHandleNodeAttributes](../../util/abstractfactory#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map) "onHandleNodeAttributes"), [wait](../../util/abstractfactory#wait(long,%20int) "wait"), [wait](../../util/abstractfactory#wait() "wait"), [wait](../../util/abstractfactory#wait(long) "wait"), [equals](../../util/abstractfactory#equals(java.lang.Object) "equals"), [toString](../../util/abstractfactory#toString() "toString"), [hashCode](../../util/abstractfactory#hashCode() "hashCode"), [getClass](../../util/abstractfactory#getClass() "getClass"), [notify](../../util/abstractfactory#notify() "notify"), [notifyAll](../../util/abstractfactory#notifyAll() "notifyAll"), [newInstance](../../util/abstractfactory#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map) "newInstance")` \| Constructor Detail ------------------ ### ImageIconFactory() Method Detail ------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) groovy [Groovy] Class RendererFactory [Groovy] Class RendererFactory ============================== * groovy.swing.factory.RendererFactory ``` class RendererFactory extends [AbstractFactory](../../util/abstractfactory "AbstractFactory") ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[RendererFactory](#RendererFactory())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| \| \| `void` \| `[onNodeCompleted](#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node)` \| \| \| `void` \| `[setChild](#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractFactory](../../util/abstractfactory "AbstractFactory")` \| `[setParent](../../util/abstractfactory#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setParent"), [isLeaf](../../util/abstractfactory#isLeaf() "isLeaf"), [onNodeChildren](../../util/abstractfactory#onNodeChildren(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20groovy.lang.Closure) "onNodeChildren"), [setChild](../../util/abstractfactory#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setChild"), [onNodeCompleted](../../util/abstractfactory#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "onNodeCompleted"), [onFactoryRegistration](../../util/abstractfactory#onFactoryRegistration(groovy.util.FactoryBuilderSupport,%20java.lang.String,%20java.lang.String) "onFactoryRegistration"), [isHandlesNodeChildren](../../util/abstractfactory#isHandlesNodeChildren() "isHandlesNodeChildren"), [onHandleNodeAttributes](../../util/abstractfactory#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map) "onHandleNodeAttributes"), [wait](../../util/abstractfactory#wait(long,%20int) "wait"), [wait](../../util/abstractfactory#wait() "wait"), [wait](../../util/abstractfactory#wait(long) "wait"), [equals](../../util/abstractfactory#equals(java.lang.Object) "equals"), [toString](../../util/abstractfactory#toString() "toString"), [hashCode](../../util/abstractfactory#hashCode() "hashCode"), [getClass](../../util/abstractfactory#getClass() "getClass"), [notify](../../util/abstractfactory#notify() "notify"), [notifyAll](../../util/abstractfactory#notifyAll() "notifyAll"), [newInstance](../../util/abstractfactory#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map) "newInstance")` \| Constructor Detail ------------------ ### RendererFactory() Method Detail ------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) ### void onNodeCompleted([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node) ### void setChild([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child)	programming_docs
groovy [Groovy] Class BeanFactory [Groovy] Class BeanFactory ========================== * groovy.swing.factory.BeanFactory ``` class BeanFactory extends [AbstractFactory](../../util/abstractfactory "AbstractFactory") ``` Since: Groovy 1.1 Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `protected boolean` \| `[leaf](#leaf)` \| \| Properties Summary ------------------ Properties \| Type \| Name and description \| \| `[Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")` \| `[beanClass](#beanClass)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[BeanFactory](#BeanFactory(java.lang.Class))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") beanClass)` \| \| `[BeanFactory](#BeanFactory(java.lang.Class,%20boolean))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") beanClass, boolean leaf)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `boolean` \| `[isLeaf](#isLeaf())()` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractFactory](../../util/abstractfactory "AbstractFactory")` \| `[setParent](../../util/abstractfactory#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setParent"), [isLeaf](../../util/abstractfactory#isLeaf() "isLeaf"), [onNodeChildren](../../util/abstractfactory#onNodeChildren(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20groovy.lang.Closure) "onNodeChildren"), [setChild](../../util/abstractfactory#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setChild"), [onNodeCompleted](../../util/abstractfactory#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "onNodeCompleted"), [onFactoryRegistration](../../util/abstractfactory#onFactoryRegistration(groovy.util.FactoryBuilderSupport,%20java.lang.String,%20java.lang.String) "onFactoryRegistration"), [isHandlesNodeChildren](../../util/abstractfactory#isHandlesNodeChildren() "isHandlesNodeChildren"), [onHandleNodeAttributes](../../util/abstractfactory#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map) "onHandleNodeAttributes"), [wait](../../util/abstractfactory#wait(long,%20int) "wait"), [wait](../../util/abstractfactory#wait() "wait"), [wait](../../util/abstractfactory#wait(long) "wait"), [equals](../../util/abstractfactory#equals(java.lang.Object) "equals"), [toString](../../util/abstractfactory#toString() "toString"), [hashCode](../../util/abstractfactory#hashCode() "hashCode"), [getClass](../../util/abstractfactory#getClass() "getClass"), [notify](../../util/abstractfactory#notify() "notify"), [notifyAll](../../util/abstractfactory#notifyAll() "notifyAll"), [newInstance](../../util/abstractfactory#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map) "newInstance")` \| Field Detail ------------ ### protected final boolean leaf Property Detail --------------- ### final [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") beanClass Constructor Detail ------------------ ### BeanFactory([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") beanClass) ### BeanFactory([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") beanClass, boolean leaf) Method Detail ------------- ### boolean isLeaf() ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) groovy [Groovy] Class TableLayoutFactory [Groovy] Class TableLayoutFactory ================================= * groovy.swing.factory.TableLayoutFactory ``` class TableLayoutFactory extends [AbstractFactory](../../util/abstractfactory "AbstractFactory") ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[TableLayoutFactory](#TableLayoutFactory())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| \| \| `void` \| `[setParent](#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractFactory](../../util/abstractfactory "AbstractFactory")` \| `[setParent](../../util/abstractfactory#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setParent"), [isLeaf](../../util/abstractfactory#isLeaf() "isLeaf"), [onNodeChildren](../../util/abstractfactory#onNodeChildren(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20groovy.lang.Closure) "onNodeChildren"), [setChild](../../util/abstractfactory#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setChild"), [onNodeCompleted](../../util/abstractfactory#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "onNodeCompleted"), [onFactoryRegistration](../../util/abstractfactory#onFactoryRegistration(groovy.util.FactoryBuilderSupport,%20java.lang.String,%20java.lang.String) "onFactoryRegistration"), [isHandlesNodeChildren](../../util/abstractfactory#isHandlesNodeChildren() "isHandlesNodeChildren"), [onHandleNodeAttributes](../../util/abstractfactory#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map) "onHandleNodeAttributes"), [wait](../../util/abstractfactory#wait(long,%20int) "wait"), [wait](../../util/abstractfactory#wait() "wait"), [wait](../../util/abstractfactory#wait(long) "wait"), [equals](../../util/abstractfactory#equals(java.lang.Object) "equals"), [toString](../../util/abstractfactory#toString() "toString"), [hashCode](../../util/abstractfactory#hashCode() "hashCode"), [getClass](../../util/abstractfactory#getClass() "getClass"), [notify](../../util/abstractfactory#notify() "notify"), [notifyAll](../../util/abstractfactory#notifyAll() "notifyAll"), [newInstance](../../util/abstractfactory#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map) "newInstance")` \| Constructor Detail ------------------ ### TableLayoutFactory() Method Detail ------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) ### void setParent([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child) groovy [Groovy] Class BindGroupFactory [Groovy] Class BindGroupFactory =============================== * groovy.swing.factory.BindGroupFactory ``` class BindGroupFactory extends [AbstractFactory](../../util/abstractfactory "AbstractFactory") ``` Factory for aggregate bindings Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[BindGroupFactory](#BindGroupFactory())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractFactory](../../util/abstractfactory "AbstractFactory")` \| `[setParent](../../util/abstractfactory#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setParent"), [isLeaf](../../util/abstractfactory#isLeaf() "isLeaf"), [onNodeChildren](../../util/abstractfactory#onNodeChildren(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20groovy.lang.Closure) "onNodeChildren"), [setChild](../../util/abstractfactory#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setChild"), [onNodeCompleted](../../util/abstractfactory#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "onNodeCompleted"), [onFactoryRegistration](../../util/abstractfactory#onFactoryRegistration(groovy.util.FactoryBuilderSupport,%20java.lang.String,%20java.lang.String) "onFactoryRegistration"), [isHandlesNodeChildren](../../util/abstractfactory#isHandlesNodeChildren() "isHandlesNodeChildren"), [onHandleNodeAttributes](../../util/abstractfactory#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map) "onHandleNodeAttributes"), [wait](../../util/abstractfactory#wait(long,%20int) "wait"), [wait](../../util/abstractfactory#wait() "wait"), [wait](../../util/abstractfactory#wait(long) "wait"), [equals](../../util/abstractfactory#equals(java.lang.Object) "equals"), [toString](../../util/abstractfactory#toString() "toString"), [hashCode](../../util/abstractfactory#hashCode() "hashCode"), [getClass](../../util/abstractfactory#getClass() "getClass"), [notify](../../util/abstractfactory#notify() "notify"), [notifyAll](../../util/abstractfactory#notifyAll() "notifyAll"), [newInstance](../../util/abstractfactory#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map) "newInstance")` \| Constructor Detail ------------------ ### BindGroupFactory() Method Detail ------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) groovy [Groovy] Class WidgetFactory [Groovy] Class WidgetFactory ============================ * groovy.swing.factory.WidgetFactory ``` class WidgetFactory extends [AbstractFactory](../../util/abstractfactory "AbstractFactory") ``` Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `protected boolean` \| `[leaf](#leaf)` \| \| Properties Summary ------------------ Properties \| Type \| Name and description \| \| `[Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")` \| `[restrictedType](#restrictedType)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[WidgetFactory](#WidgetFactory(java.lang.Class,%20boolean))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") restrictedType, boolean leaf)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `boolean` \| `[isLeaf](#isLeaf())()` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| \| \| `void` \| `[setChild](#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractFactory](../../util/abstractfactory "AbstractFactory")` \| `[setParent](../../util/abstractfactory#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setParent"), [isLeaf](../../util/abstractfactory#isLeaf() "isLeaf"), [onNodeChildren](../../util/abstractfactory#onNodeChildren(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20groovy.lang.Closure) "onNodeChildren"), [setChild](../../util/abstractfactory#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setChild"), [onNodeCompleted](../../util/abstractfactory#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "onNodeCompleted"), [onFactoryRegistration](../../util/abstractfactory#onFactoryRegistration(groovy.util.FactoryBuilderSupport,%20java.lang.String,%20java.lang.String) "onFactoryRegistration"), [isHandlesNodeChildren](../../util/abstractfactory#isHandlesNodeChildren() "isHandlesNodeChildren"), [onHandleNodeAttributes](../../util/abstractfactory#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map) "onHandleNodeAttributes"), [wait](../../util/abstractfactory#wait(long,%20int) "wait"), [wait](../../util/abstractfactory#wait() "wait"), [wait](../../util/abstractfactory#wait(long) "wait"), [equals](../../util/abstractfactory#equals(java.lang.Object) "equals"), [toString](../../util/abstractfactory#toString() "toString"), [hashCode](../../util/abstractfactory#hashCode() "hashCode"), [getClass](../../util/abstractfactory#getClass() "getClass"), [notify](../../util/abstractfactory#notify() "notify"), [notifyAll](../../util/abstractfactory#notifyAll() "notifyAll"), [newInstance](../../util/abstractfactory#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map) "newInstance")` \| Field Detail ------------ ### protected final boolean leaf Property Detail --------------- ### final [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") restrictedType Constructor Detail ------------------ ### WidgetFactory([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") restrictedType, boolean leaf) Method Detail ------------- ### boolean isLeaf() ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) ### void setChild([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child) groovy [Groovy] Class FrameFactory [Groovy] Class FrameFactory =========================== * groovy.swing.factory.FrameFactory ``` class FrameFactory extends [RootPaneContainerFactory](rootpanecontainerfactory) ``` Inherited fields \| Fields inherited from class \| Fields \| \| `class [RootPaneContainerFactory](rootpanecontainerfactory)` \| `[DEFAULT\_DELEGATE\_PROPERTY\_DEFAULT\_BUTTON](rootpanecontainerfactory#DEFAULT_DELEGATE_PROPERTY_DEFAULT_BUTTON), [DELEGATE\_PROPERTY\_DEFAULT\_BUTTON](rootpanecontainerfactory#DELEGATE_PROPERTY_DEFAULT_BUTTON)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[FrameFactory](#FrameFactory())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| \| \| `void` \| `[setChild](#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))([FactoryBuilderSupport](../../util/factorybuildersupport) build, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [RootPaneContainerFactory](rootpanecontainerfactory)` \| `[handleRootPaneTasks](rootpanecontainerfactory#handleRootPaneTasks(groovy.util.FactoryBuilderSupport,%20java.awt.Window,%20java.util.Map)), [onNodeCompleted](rootpanecontainerfactory#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object)), [setChild](rootpanecontainerfactory#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))` \| Constructor Detail ------------------ ### FrameFactory() Method Detail ------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) ### void setChild([FactoryBuilderSupport](../../util/factorybuildersupport) build, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child)	programming_docs
groovy [Groovy] Class SeparatorFactory [Groovy] Class SeparatorFactory =============================== * groovy.swing.factory.SeparatorFactory ``` class SeparatorFactory extends [AbstractFactory](../../util/abstractfactory "AbstractFactory") ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[SeparatorFactory](#SeparatorFactory())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractFactory](../../util/abstractfactory "AbstractFactory")` \| `[setParent](../../util/abstractfactory#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setParent"), [isLeaf](../../util/abstractfactory#isLeaf() "isLeaf"), [onNodeChildren](../../util/abstractfactory#onNodeChildren(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20groovy.lang.Closure) "onNodeChildren"), [setChild](../../util/abstractfactory#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setChild"), [onNodeCompleted](../../util/abstractfactory#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "onNodeCompleted"), [onFactoryRegistration](../../util/abstractfactory#onFactoryRegistration(groovy.util.FactoryBuilderSupport,%20java.lang.String,%20java.lang.String) "onFactoryRegistration"), [isHandlesNodeChildren](../../util/abstractfactory#isHandlesNodeChildren() "isHandlesNodeChildren"), [onHandleNodeAttributes](../../util/abstractfactory#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map) "onHandleNodeAttributes"), [wait](../../util/abstractfactory#wait(long,%20int) "wait"), [wait](../../util/abstractfactory#wait() "wait"), [wait](../../util/abstractfactory#wait(long) "wait"), [equals](../../util/abstractfactory#equals(java.lang.Object) "equals"), [toString](../../util/abstractfactory#toString() "toString"), [hashCode](../../util/abstractfactory#hashCode() "hashCode"), [getClass](../../util/abstractfactory#getClass() "getClass"), [notify](../../util/abstractfactory#notify() "notify"), [notifyAll](../../util/abstractfactory#notifyAll() "notifyAll"), [newInstance](../../util/abstractfactory#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map) "newInstance")` \| Constructor Detail ------------------ ### SeparatorFactory() Method Detail ------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) groovy [Groovy] Class SplitPaneFactory [Groovy] Class SplitPaneFactory =============================== * groovy.swing.factory.SplitPaneFactory ``` class SplitPaneFactory extends [AbstractFactory](../../util/abstractfactory "AbstractFactory") ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[SplitPaneFactory](#SplitPaneFactory())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| \| \| `void` \| `[setChild](#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object))([FactoryBuilderSupport](../../util/factorybuildersupport) factory, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractFactory](../../util/abstractfactory "AbstractFactory")` \| `[setParent](../../util/abstractfactory#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setParent"), [isLeaf](../../util/abstractfactory#isLeaf() "isLeaf"), [onNodeChildren](../../util/abstractfactory#onNodeChildren(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20groovy.lang.Closure) "onNodeChildren"), [setChild](../../util/abstractfactory#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setChild"), [onNodeCompleted](../../util/abstractfactory#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "onNodeCompleted"), [onFactoryRegistration](../../util/abstractfactory#onFactoryRegistration(groovy.util.FactoryBuilderSupport,%20java.lang.String,%20java.lang.String) "onFactoryRegistration"), [isHandlesNodeChildren](../../util/abstractfactory#isHandlesNodeChildren() "isHandlesNodeChildren"), [onHandleNodeAttributes](../../util/abstractfactory#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map) "onHandleNodeAttributes"), [wait](../../util/abstractfactory#wait(long,%20int) "wait"), [wait](../../util/abstractfactory#wait() "wait"), [wait](../../util/abstractfactory#wait(long) "wait"), [equals](../../util/abstractfactory#equals(java.lang.Object) "equals"), [toString](../../util/abstractfactory#toString() "toString"), [hashCode](../../util/abstractfactory#hashCode() "hashCode"), [getClass](../../util/abstractfactory#getClass() "getClass"), [notify](../../util/abstractfactory#notify() "notify"), [notifyAll](../../util/abstractfactory#notifyAll() "notifyAll"), [newInstance](../../util/abstractfactory#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map) "newInstance")` \| Constructor Detail ------------------ ### SplitPaneFactory() Method Detail ------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) ### void setChild([FactoryBuilderSupport](../../util/factorybuildersupport) factory, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child) groovy [Groovy] Class RichActionWidgetFactory [Groovy] Class RichActionWidgetFactory ====================================== * groovy.swing.factory.RichActionWidgetFactory ``` class RichActionWidgetFactory extends [AbstractFactory](../../util/abstractfactory "AbstractFactory") ``` Properties Summary ------------------ Properties \| Type \| Name and description \| \| `static [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")[]` \| `[ACTION\_ARGS](#ACTION_ARGS)` \| \| `static [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")[]` \| `[ICON\_ARGS](#ICON_ARGS)` \| \| `static [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")[]` \| `[STRING\_ARGS](#STRING_ARGS)` \| \| `[Constructor](https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Constructor.html "Constructor")` \| `[actionCtor](#actionCtor)` \| \| `[Constructor](https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Constructor.html "Constructor")` \| `[iconCtor](#iconCtor)` \| \| `[Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")` \| `[klass](#klass)` \| \| `[Constructor](https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Constructor.html "Constructor")` \| `[stringCtor](#stringCtor)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[RichActionWidgetFactory](#RichActionWidgetFactory(java.lang.Class))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") klass)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractFactory](../../util/abstractfactory "AbstractFactory")` \| `[setParent](../../util/abstractfactory#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setParent"), [isLeaf](../../util/abstractfactory#isLeaf() "isLeaf"), [onNodeChildren](../../util/abstractfactory#onNodeChildren(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20groovy.lang.Closure) "onNodeChildren"), [setChild](../../util/abstractfactory#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setChild"), [onNodeCompleted](../../util/abstractfactory#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "onNodeCompleted"), [onFactoryRegistration](../../util/abstractfactory#onFactoryRegistration(groovy.util.FactoryBuilderSupport,%20java.lang.String,%20java.lang.String) "onFactoryRegistration"), [isHandlesNodeChildren](../../util/abstractfactory#isHandlesNodeChildren() "isHandlesNodeChildren"), [onHandleNodeAttributes](../../util/abstractfactory#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map) "onHandleNodeAttributes"), [wait](../../util/abstractfactory#wait(long,%20int) "wait"), [wait](../../util/abstractfactory#wait() "wait"), [wait](../../util/abstractfactory#wait(long) "wait"), [equals](../../util/abstractfactory#equals(java.lang.Object) "equals"), [toString](../../util/abstractfactory#toString() "toString"), [hashCode](../../util/abstractfactory#hashCode() "hashCode"), [getClass](../../util/abstractfactory#getClass() "getClass"), [notify](../../util/abstractfactory#notify() "notify"), [notifyAll](../../util/abstractfactory#notifyAll() "notifyAll"), [newInstance](../../util/abstractfactory#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map) "newInstance")` \| Property Detail --------------- ### static final [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")[] ACTION\_ARGS ### static final [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")[] ICON\_ARGS ### static final [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")[] STRING\_ARGS ### final [Constructor](https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Constructor.html "Constructor") actionCtor ### final [Constructor](https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Constructor.html "Constructor") iconCtor ### final [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") klass ### final [Constructor](https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Constructor.html "Constructor") stringCtor Constructor Detail ------------------ ### RichActionWidgetFactory([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") klass) Method Detail ------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) groovy [Groovy] Class FormattedTextFactory [Groovy] Class FormattedTextFactory =================================== * groovy.swing.factory.FormattedTextFactory ``` class FormattedTextFactory extends [AbstractFactory](../../util/abstractfactory "AbstractFactory") ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[FormattedTextFactory](#FormattedTextFactory())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractFactory](../../util/abstractfactory "AbstractFactory")` \| `[setParent](../../util/abstractfactory#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setParent"), [isLeaf](../../util/abstractfactory#isLeaf() "isLeaf"), [onNodeChildren](../../util/abstractfactory#onNodeChildren(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20groovy.lang.Closure) "onNodeChildren"), [setChild](../../util/abstractfactory#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setChild"), [onNodeCompleted](../../util/abstractfactory#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "onNodeCompleted"), [onFactoryRegistration](../../util/abstractfactory#onFactoryRegistration(groovy.util.FactoryBuilderSupport,%20java.lang.String,%20java.lang.String) "onFactoryRegistration"), [isHandlesNodeChildren](../../util/abstractfactory#isHandlesNodeChildren() "isHandlesNodeChildren"), [onHandleNodeAttributes](../../util/abstractfactory#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map) "onHandleNodeAttributes"), [wait](../../util/abstractfactory#wait(long,%20int) "wait"), [wait](../../util/abstractfactory#wait() "wait"), [wait](../../util/abstractfactory#wait(long) "wait"), [equals](../../util/abstractfactory#equals(java.lang.Object) "equals"), [toString](../../util/abstractfactory#toString() "toString"), [hashCode](../../util/abstractfactory#hashCode() "hashCode"), [getClass](../../util/abstractfactory#getClass() "getClass"), [notify](../../util/abstractfactory#notify() "notify"), [notifyAll](../../util/abstractfactory#notifyAll() "notifyAll"), [newInstance](../../util/abstractfactory#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map) "newInstance")` \| Constructor Detail ------------------ ### FormattedTextFactory() Method Detail ------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) groovy [Groovy] Class MapFactory [Groovy] Class MapFactory ========================= * groovy.swing.factory.MapFactory ``` class MapFactory extends [AbstractFactory](../../util/abstractfactory "AbstractFactory") ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[MapFactory](#MapFactory())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newInstance](#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map))([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [AbstractFactory](../../util/abstractfactory "AbstractFactory")` \| `[setParent](../../util/abstractfactory#setParent(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setParent"), [isLeaf](../../util/abstractfactory#isLeaf() "isLeaf"), [onNodeChildren](../../util/abstractfactory#onNodeChildren(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20groovy.lang.Closure) "onNodeChildren"), [setChild](../../util/abstractfactory#setChild(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "setChild"), [onNodeCompleted](../../util/abstractfactory#onNodeCompleted(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object) "onNodeCompleted"), [onFactoryRegistration](../../util/abstractfactory#onFactoryRegistration(groovy.util.FactoryBuilderSupport,%20java.lang.String,%20java.lang.String) "onFactoryRegistration"), [isHandlesNodeChildren](../../util/abstractfactory#isHandlesNodeChildren() "isHandlesNodeChildren"), [onHandleNodeAttributes](../../util/abstractfactory#onHandleNodeAttributes(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.util.Map) "onHandleNodeAttributes"), [wait](../../util/abstractfactory#wait(long,%20int) "wait"), [wait](../../util/abstractfactory#wait() "wait"), [wait](../../util/abstractfactory#wait(long) "wait"), [equals](../../util/abstractfactory#equals(java.lang.Object) "equals"), [toString](../../util/abstractfactory#toString() "toString"), [hashCode](../../util/abstractfactory#hashCode() "hashCode"), [getClass](../../util/abstractfactory#getClass() "getClass"), [notify](../../util/abstractfactory#notify() "notify"), [notifyAll](../../util/abstractfactory#notifyAll() "notifyAll"), [newInstance](../../util/abstractfactory#newInstance(groovy.util.FactoryBuilderSupport,%20java.lang.Object,%20java.lang.Object,%20java.util.Map) "newInstance")` \| Constructor Detail ------------------ ### MapFactory() Method Detail ------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newInstance([FactoryBuilderSupport](../../util/factorybuildersupport) builder, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)	programming_docs
groovy [Java] Enum FileVisitResult [Java] Enum FileVisitResult =========================== * groovy.io.FileVisitResult ``` public enum FileVisitResult extends [Enum](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html "Enum") ``` Represents special return values for the 'preDir', 'postDir' and 'visit'/supplied Closures used with [ResourceGroovyMethods.traverse](../../org/codehaus/groovy/runtime/resourcegroovymethods#traverse(java.io.File,%20java.util.Map,%20groovy.lang.Closure) "ResourceGroovyMethods.traverse") and related methods to control subsequent traversal behavior. Enum Constants Summary ---------------------- Enum constants classes \| Enum constant \| Description \| \| `[CONTINUE](#CONTINUE)` \| Continue processing; the default \| \| `[SKIP\_SIBLINGS](#SKIP_SIBLINGS)` \| Skip processing sibling files/directories within the current directory being processed \| \| `[SKIP\_SUBTREE](#SKIP_SUBTREE)` \| Do not process the child files/subdirectories within the current directory being processed \| \| `[TERMINATE](#TERMINATE)` \| Do not process any more files \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Enum](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html "Enum")` \| `[name](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#name() "name"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#hashCode() "hashCode"), [compareTo](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#compareTo(java.lang.Object) "compareTo"), [compareTo](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#compareTo(java.lang.Enum) "compareTo"), [valueOf](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#valueOf(java.lang.Class,%20java.lang.String) "valueOf"), [describeConstable](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#describeConstable() "describeConstable"), [getDeclaringClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#getDeclaringClass() "getDeclaringClass"), [ordinal](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#ordinal() "ordinal"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#wait(long) "wait"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#notifyAll() "notifyAll")` \| Enum Constant Detail -------------------- ### public [FileVisitResult](filevisitresult) CONTINUE Continue processing; the default ### public [FileVisitResult](filevisitresult) SKIP\_SIBLINGS Skip processing sibling files/directories within the current directory being processed ### public [FileVisitResult](filevisitresult) SKIP\_SUBTREE Do not process the child files/subdirectories within the current directory being processed ### public [FileVisitResult](filevisitresult) TERMINATE Do not process any more files groovy [Java] Class GroovyPrintWriter [Java] Class GroovyPrintWriter ============================== * groovy.io.GroovyPrintWriter ``` public class GroovyPrintWriter extends [PrintWriter](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html "PrintWriter") ``` A PrintWriter that outputs objects in Groovy style. That means print(Object) uses InvokerHelper.toString(Object) to produce the same results as Writer.print(Object). Since: 1.6 Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[GroovyPrintWriter](#GroovyPrintWriter(java.io.File))([File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File") file)` \| \| `[GroovyPrintWriter](#GroovyPrintWriter(java.io.File,%20java.lang.String))([File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File") file, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") csn)` \| \| `[GroovyPrintWriter](#GroovyPrintWriter(java.io.Writer))([Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") out)` \| \| `[GroovyPrintWriter](#GroovyPrintWriter(java.io.Writer,%20boolean))([Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") out, boolean autoflush)` \| \| `[GroovyPrintWriter](#GroovyPrintWriter(java.io.OutputStream))([OutputStream](https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html "OutputStream") out)` \| \| `[GroovyPrintWriter](#GroovyPrintWriter(java.io.OutputStream,%20boolean))([OutputStream](https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html "OutputStream") out, boolean autoflush)` \| \| `[GroovyPrintWriter](#GroovyPrintWriter(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") filename)` \| \| `[GroovyPrintWriter](#GroovyPrintWriter(java.lang.String,%20java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") filename, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") csn)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public void` \| `[print](#print(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") x)` \| \| \| `public void` \| `[println](#println(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") x)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [PrintWriter](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html "PrintWriter")` \| `[println](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#println(%5BC) "println"), [println](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#println() "println"), [println](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#println(boolean) "println"), [println](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#println(java.lang.String) "println"), [println](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#println(java.lang.Object) "println"), [println](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#println(double) "println"), [println](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#println(float) "println"), [println](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#println(long) "println"), [println](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#println(int) "println"), [println](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#println(char) "println"), [append](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#append(java.lang.CharSequence,%20int,%20int) "append"), [append](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#append(java.lang.CharSequence,%20int,%20int) "append"), [append](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#append(java.lang.CharSequence,%20int,%20int) "append"), [append](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#append(char) "append"), [append](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#append(char) "append"), [append](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#append(char) "append"), [append](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#append(java.lang.CharSequence) "append"), [append](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#append(java.lang.CharSequence) "append"), [append](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#append(java.lang.CharSequence) "append"), [flush](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#flush() "flush"), [format](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#format(java.lang.String,%20%5BLjava.lang.Object;) "format"), [format](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#format(java.util.Locale,%20java.lang.String,%20%5BLjava.lang.Object;) "format"), [printf](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#printf(java.lang.String,%20%5BLjava.lang.Object;) "printf"), [printf](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#printf(java.util.Locale,%20java.lang.String,%20%5BLjava.lang.Object;) "printf"), [write](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#write(%5BC,%20int,%20int) "write"), [write](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#write(java.lang.String) "write"), [write](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#write(java.lang.String,%20int,%20int) "write"), [write](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#write(%5BC) "write"), [write](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#write(int) "write"), [print](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#print(float) "print"), [print](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#print(long) "print"), [print](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#print(int) "print"), [print](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#print(char) "print"), [print](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#print(boolean) "print"), [print](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#print(java.lang.Object) "print"), [print](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#print(java.lang.String) "print"), [print](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#print(%5BC) "print"), [print](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#print(double) "print"), [close](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#close() "close"), [checkError](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#checkError() "checkError"), [nullWriter](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#nullWriter() "nullWriter"), [wait](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public GroovyPrintWriter([File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File") file) ### public GroovyPrintWriter([File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File") file, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") csn) ### public GroovyPrintWriter([Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") out) ### public GroovyPrintWriter([Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") out, boolean autoflush) ### public GroovyPrintWriter([OutputStream](https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html "OutputStream") out) ### public GroovyPrintWriter([OutputStream](https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html "OutputStream") out, boolean autoflush) ### public GroovyPrintWriter([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") filename) ### public GroovyPrintWriter([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") filename, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") csn) Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void print([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") x) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void println([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") x) groovy [Java] Enum FileType [Java] Enum FileType ==================== * groovy.io.FileType ``` public enum FileType extends [Enum](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html "Enum") ``` Represents particular files of interest. Enum Constants Summary ---------------------- Enum constants classes \| Enum constant \| Description \| \| `[ANY](#ANY)` \| Represents both normal files and directories \| \| `[DIRECTORIES](#DIRECTORIES)` \| Represents directories \| \| `[FILES](#FILES)` \| Represents normal files \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Enum](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html "Enum")` \| `[name](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#name() "name"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#hashCode() "hashCode"), [compareTo](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#compareTo(java.lang.Object) "compareTo"), [compareTo](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#compareTo(java.lang.Enum) "compareTo"), [valueOf](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#valueOf(java.lang.Class,%20java.lang.String) "valueOf"), [describeConstable](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#describeConstable() "describeConstable"), [getDeclaringClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#getDeclaringClass() "getDeclaringClass"), [ordinal](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#ordinal() "ordinal"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#wait(long) "wait"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#notifyAll() "notifyAll")` \| Enum Constant Detail -------------------- ### public [FileType](filetype) ANY Represents both normal files and directories ### public [FileType](filetype) DIRECTORIES Represents directories ### public [FileType](filetype) FILES Represents normal files groovy [Java] Class LineColumnReader [Java] Class LineColumnReader ============================= * groovy.io.LineColumnReader ``` public class LineColumnReader extends [BufferedReader](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedReader.html "BufferedReader") ``` The `LineColumnReader` is an extension to `BufferedReader` that keeps track of the line and column information of where the cursor is. Since: 1.8.0 Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[LineColumnReader](#LineColumnReader(java.io.Reader))([Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") reader)`Constructor wrapping a `Reader` (`FileReader`, `FileReader`, `InputStreamReader`, etc.) \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public void` \| `[close](#close())()`Closes the stream and releases any system resources associated with it. \| \| \| `public long` \| `[getColumn](#getColumn())()` \| \| \| `public long` \| `[getColumnMark](#getColumnMark())()` \| \| \| `public long` \| `[getLine](#getLine())()` \| \| \| `public long` \| `[getLineMark](#getLineMark())()` \| \| \| `public void` \| `[mark](#mark(int))(int readAheadLimit)`Marks the present position in the stream. \| \| \| `public int` \| `[read](#read())()`Reads a single character. \| \| \| `public int` \| `[read](#read(char%5B%5D,%20int,%20int))(char[] chars, int startOffset, int length)`Reads characters into a portion of an array. \| \| \| `public int` \| `[read](#read(char%5B%5D))(char[] chars)`Reads characters into an array. \| \| \| `public int` \| `[read](#read(java.nio.CharBuffer))([CharBuffer](https://docs.oracle.com/javase/8/docs/api/java/nio/CharBuffer.html "CharBuffer") buffer)`Not implemented. \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[readLine](#readLine())()`Reads a line of text. \| \| \| `public void` \| `[reset](#reset())()`Resets the stream to the most recent mark. \| \| \| `public void` \| `[setColumn](#setColumn(long))(long column)` \| \| \| `public void` \| `[setColumnMark](#setColumnMark(long))(long columnMark)` \| \| \| `public void` \| `[setLine](#setLine(long))(long line)` \| \| \| `public void` \| `[setLineMark](#setLineMark(long))(long lineMark)` \| \| \| `public long` \| `[skip](#skip(long))(long toSkip)`Skips characters. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [BufferedReader](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedReader.html "BufferedReader")` \| `[lines](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedReader.html#lines() "lines"), [read](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedReader.html#read() "read"), [read](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedReader.html#read(%5BC,%20int,%20int) "read"), [readLine](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedReader.html#readLine() "readLine"), [close](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedReader.html#close() "close"), [mark](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedReader.html#mark(int) "mark"), [skip](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedReader.html#skip(long) "skip"), [markSupported](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedReader.html#markSupported() "markSupported"), [reset](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedReader.html#reset() "reset"), [ready](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedReader.html#ready() "ready"), [read](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedReader.html#read(%5BC) "read"), [read](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedReader.html#read(java.nio.CharBuffer) "read"), [transferTo](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedReader.html#transferTo(java.io.Writer) "transferTo"), [nullReader](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedReader.html#nullReader() "nullReader"), [wait](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedReader.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedReader.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedReader.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedReader.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedReader.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedReader.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedReader.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedReader.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedReader.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public LineColumnReader([Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") reader) Constructor wrapping a `Reader` (`FileReader`, `FileReader`, `InputStreamReader`, etc.) Parameters: `reader` - the reader to wrap Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void close() Closes the stream and releases any system resources associated with it. Once the stream has been closed, further read(), ready(), mark(), reset(), or skip() invocations will throw an IOException. Closing a previously closed stream has no effect. ### public long getColumn() ### public long getColumnMark() ### public long getLine() ### public long getLineMark() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void mark(int readAheadLimit) Marks the present position in the stream. Subsequent calls to reset() will attempt to reposition the stream to this point. Parameters: `readAheadLimit` - Limit on the number of characters that may be read while still preserving the mark. An attempt to reset the stream after reading characters up to this limit or beyond may fail. A limit value larger than the size of the input buffer will cause a new buffer to be allocated whose size is no smaller than limit. Therefore large values should be used with care. ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public int read() Reads a single character. Returns: The character read, as an integer in the range 0 to 65535 (0x00-0xffff), or -1 if the end of the stream has been reached ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public int read(char[] chars, int startOffset, int length) Reads characters into a portion of an array. Parameters: `chars` - Destination array of char `startOffset` - Offset at which to start storing characters `length` - Maximum number of characters to read Returns: an exception if an error occurs ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public int read(char[] chars) Reads characters into an array. This method will block until some input is available, an I/O error occurs, or the end of the stream is reached. Parameters: `chars` - Destination buffer Returns: The number of characters read, or -1 if the end of the stream has been reached ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public int read([CharBuffer](https://docs.oracle.com/javase/8/docs/api/java/nio/CharBuffer.html "CharBuffer") buffer) Not implemented. throws: UnsupportedOperationException as the method is not implemented Parameters: `buffer` - Destination buffer Returns: The number of characters read, or -1 if the end of the stream has been reached ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") readLine() Reads a line of text. A line is considered to be terminated by any one of a line feed ('\n'), a carriage return ('\r'), or a carriage return followed immediately by a linefeed. Returns: A String containing the contents of the line, not including any line-termination characters, or null if the end of the stream has been reached ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void reset() Resets the stream to the most recent mark. ### public void setColumn(long column) ### public void setColumnMark(long columnMark) ### public void setLine(long line) ### public void setLineMark(long lineMark) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public long skip(long toSkip) Skips characters. Parameters: `toSkip` - the number of characters to skip Returns: The number of characters actually skipped	programming_docs
groovy [Java] Class GroovyPrintStream [Java] Class GroovyPrintStream ============================== * groovy.io.GroovyPrintStream ``` public class GroovyPrintStream extends [PrintStream](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html "PrintStream") ``` A PrintStream that outputs objects in Groovy style. That means print(Object) uses InvokerHelper.toString(Object) to produce the same results as Writer.print(Object). Since: 1.6 Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[GroovyPrintStream](#GroovyPrintStream(java.io.OutputStream))([OutputStream](https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html "OutputStream") out)`Creates a new print stream. \| \| `[GroovyPrintStream](#GroovyPrintStream(java.io.OutputStream,%20boolean))([OutputStream](https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html "OutputStream") out, boolean autoFlush)`Creates a new print stream. \| \| `[GroovyPrintStream](#GroovyPrintStream(java.io.OutputStream,%20boolean,%20java.lang.String))([OutputStream](https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html "OutputStream") out, boolean autoFlush, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") encoding)`Creates a new print stream. \| \| `[GroovyPrintStream](#GroovyPrintStream(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") fileName)`Creates a new print stream, without automatic line flushing, with the specified file name. \| \| `[GroovyPrintStream](#GroovyPrintStream(java.lang.String,%20java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") fileName, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") csn)`Creates a new print stream, without automatic line flushing, with the specified file name and charset. \| \| `[GroovyPrintStream](#GroovyPrintStream(java.io.File))([File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File") file)`Creates a new print stream, without automatic line flushing, with the specified file. \| \| `[GroovyPrintStream](#GroovyPrintStream(java.io.File,%20java.lang.String))([File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File") file, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") csn)`Creates a new print stream, without automatic line flushing, with the specified file and charset. \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public void` \| `[print](#print(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") obj)`Prints an object Groovy style. \| \| \| `public void` \| `[println](#println(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") obj)`Prints an object Groovy style followed by a newline. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [PrintStream](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html "PrintStream")` \| `[println](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#println(java.lang.String) "println"), [println](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#println(java.lang.Object) "println"), [println](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#println(float) "println"), [println](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#println(double) "println"), [println](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#println(%5BC) "println"), [println](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#println(boolean) "println"), [println](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#println() "println"), [println](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#println(char) "println"), [println](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#println(int) "println"), [println](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#println(long) "println"), [append](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#append(java.lang.CharSequence) "append"), [append](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#append(java.lang.CharSequence) "append"), [append](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#append(java.lang.CharSequence,%20int,%20int) "append"), [append](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#append(java.lang.CharSequence,%20int,%20int) "append"), [append](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#append(char) "append"), [append](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#append(char) "append"), [flush](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#flush() "flush"), [format](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#format(java.lang.String,%20%5BLjava.lang.Object;) "format"), [format](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#format(java.util.Locale,%20java.lang.String,%20%5BLjava.lang.Object;) "format"), [printf](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#printf(java.util.Locale,%20java.lang.String,%20%5BLjava.lang.Object;) "printf"), [printf](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#printf(java.lang.String,%20%5BLjava.lang.Object;) "printf"), [write](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#write(%5BB,%20int,%20int) "write"), [write](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#write(int) "write"), [write](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#write(%5BB) "write"), [print](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#print(boolean) "print"), [print](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#print(java.lang.String) "print"), [print](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#print(%5BC) "print"), [print](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#print(long) "print"), [print](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#print(double) "print"), [print](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#print(float) "print"), [print](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#print(char) "print"), [print](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#print(int) "print"), [print](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#print(java.lang.Object) "print"), [close](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#close() "close"), [writeBytes](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#writeBytes(%5BB) "writeBytes"), [checkError](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#checkError() "checkError"), [nullOutputStream](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#nullOutputStream() "nullOutputStream"), [wait](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public GroovyPrintStream([OutputStream](https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html "OutputStream") out) Creates a new print stream. This stream will not flush automatically. See Also: [PrintStream.PrintStream](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#PrintStream(java.io.OutputStream) "PrintStream.PrintStream") ### public GroovyPrintStream([OutputStream](https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html "OutputStream") out, boolean autoFlush) Creates a new print stream. See Also: [PrintStream.PrintStream](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#PrintStream(java.io.OutputStream,%20boolean) "PrintStream.PrintStream") ### public GroovyPrintStream([OutputStream](https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html "OutputStream") out, boolean autoFlush, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") encoding) Creates a new print stream. See Also: [PrintStream.PrintStream](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#PrintStream(java.io.OutputStream,%20boolean,%20String) "PrintStream.PrintStream") ### public GroovyPrintStream([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") fileName) Creates a new print stream, without automatic line flushing, with the specified file name. See Also: [PrintStream.PrintStream](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#PrintStream(String) "PrintStream.PrintStream") ### public GroovyPrintStream([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") fileName, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") csn) Creates a new print stream, without automatic line flushing, with the specified file name and charset. See Also: [PrintStream.PrintStream](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#PrintStream(String,%20String) "PrintStream.PrintStream") ### public GroovyPrintStream([File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File") file) Creates a new print stream, without automatic line flushing, with the specified file. See Also: [PrintStream.PrintStream](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#PrintStream(File) "PrintStream.PrintStream") ### public GroovyPrintStream([File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File") file, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") csn) Creates a new print stream, without automatic line flushing, with the specified file and charset. See Also: [PrintStream.PrintStream](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html#PrintStream(File,%20String) "PrintStream.PrintStream") Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void print([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") obj) Prints an object Groovy style. Parameters: `obj` - The `Object` to be printed ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void println([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") obj) Prints an object Groovy style followed by a newline. Parameters: `obj` - The `Object` to be printed groovy [Java] Class EncodingAwareBufferedWriter [Java] Class EncodingAwareBufferedWriter ======================================== * groovy.io.EncodingAwareBufferedWriter ``` public class EncodingAwareBufferedWriter extends [BufferedWriter](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedWriter.html "BufferedWriter") ``` A buffered writer only for OutputStreamWriter that is aware of the encoding of the OutputStreamWriter. Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[EncodingAwareBufferedWriter](#EncodingAwareBufferedWriter(java.io.OutputStreamWriter))([OutputStreamWriter](https://docs.oracle.com/javase/8/docs/api/java/io/OutputStreamWriter.html "OutputStreamWriter") out)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getEncoding](#getEncoding())()`The encoding as returned by the underlying OutputStreamWriter. \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getNormalizedEncoding](#getNormalizedEncoding())()`The encoding as returned by the underlying OutputStreamWriter. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [BufferedWriter](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedWriter.html "BufferedWriter")` \| `[flush](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedWriter.html#flush() "flush"), [write](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedWriter.html#write(%5BC,%20int,%20int) "write"), [write](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedWriter.html#write(java.lang.String,%20int,%20int) "write"), [write](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedWriter.html#write(int) "write"), [newLine](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedWriter.html#newLine() "newLine"), [close](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedWriter.html#close() "close"), [append](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedWriter.html#append(java.lang.CharSequence,%20int,%20int) "append"), [append](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedWriter.html#append(java.lang.CharSequence,%20int,%20int) "append"), [append](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedWriter.html#append(char) "append"), [append](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedWriter.html#append(char) "append"), [append](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedWriter.html#append(java.lang.CharSequence) "append"), [append](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedWriter.html#append(java.lang.CharSequence) "append"), [write](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedWriter.html#write(java.lang.String) "write"), [write](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedWriter.html#write(%5BC) "write"), [nullWriter](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedWriter.html#nullWriter() "nullWriter"), [wait](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedWriter.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedWriter.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedWriter.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedWriter.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedWriter.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedWriter.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedWriter.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedWriter.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/io/BufferedWriter.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public EncodingAwareBufferedWriter([OutputStreamWriter](https://docs.oracle.com/javase/8/docs/api/java/io/OutputStreamWriter.html "OutputStreamWriter") out) Method Detail ------------- ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getEncoding() The encoding as returned by the underlying OutputStreamWriter. Can be the historical name. Returns: the encoding See Also: [OutputStreamWriter.getEncoding](https://docs.oracle.com/javase/8/docs/api/java/io/OutputStreamWriter.html#getEncoding() "OutputStreamWriter.getEncoding") ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getNormalizedEncoding() The encoding as returned by the underlying OutputStreamWriter. Will be the preferred name. Returns: the encoding See Also: [OutputStreamWriter.getEncoding](https://docs.oracle.com/javase/8/docs/api/java/io/OutputStreamWriter.html#getEncoding() "OutputStreamWriter.getEncoding") groovy [Java] Class PlatformLineWriter [Java] Class PlatformLineWriter =============================== * groovy.io.PlatformLineWriter ``` public class PlatformLineWriter extends [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") ``` A buffered writer that gobbles any \r characters and replaces every \n with a platform specific newline. In many places Groovy normalises streams to only have \n characters but when creating files that must be used by other platform-aware tools, you sometimes want the newlines to match what the platform expects. Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[PlatformLineWriter](#PlatformLineWriter(java.io.Writer))([Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") out)` \| \| `[PlatformLineWriter](#PlatformLineWriter(java.io.Writer,%20int))([Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") out, int sz)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public void` \| `[close](#close())()` \| \| \| `public void` \| `[flush](#flush())()` \| \| \| `public void` \| `[write](#write(char%5B%5D,%20int,%20int))(char[] cbuf, int off, int len)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer")` \| `[append](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#append(java.lang.CharSequence,%20int,%20int) "append"), [append](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#append(java.lang.CharSequence,%20int,%20int) "append"), [append](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#append(char) "append"), [append](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#append(char) "append"), [append](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#append(java.lang.CharSequence) "append"), [append](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#append(java.lang.CharSequence) "append"), [flush](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#flush() "flush"), [write](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#write(java.lang.String,%20int,%20int) "write"), [write](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#write(int) "write"), [write](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#write(java.lang.String) "write"), [write](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#write(%5BC,%20int,%20int) "write"), [write](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#write(%5BC) "write"), [close](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#close() "close"), [nullWriter](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#nullWriter() "nullWriter"), [wait](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public PlatformLineWriter([Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") out) ### public PlatformLineWriter([Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") out, int sz) Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void close() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void flush() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void write(char[] cbuf, int off, int len)	programming_docs
groovy [Java] Class QName [Java] Class QName ================== * groovy.namespace.QName All Implemented Interfaces and Traits: [Serializable](https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html "Serializable") ``` public class QName extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") implements [Serializable](https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html "Serializable") ``` `QName` class represents the value of a qualified name as specified in [XML Schema Part2: Datatypes specification](http://www.w3.org/TR/xmlschema-2/#QName). The value of a QName contains a namespaceURI, a localPart and a prefix. The localPart provides the local part of the qualified name. The namespaceURI is a URI reference identifying the namespace. Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[QName](#QName(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") localPart)`Constructor for the QName. \| \| `[QName](#QName(java.lang.String,%20java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") namespaceURI, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") localPart)`Constructor for the QName. \| \| `[QName](#QName(java.lang.String,%20java.lang.String,%20java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") namespaceURI, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") localPart, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") prefix)`Constructor for the QName. \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public boolean` \| `[equals](#equals(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o)`Tests this QName for equality with another object. \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getLocalPart](#getLocalPart())()`Gets the Local part for this QName \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getNamespaceURI](#getNamespaceURI())()`Gets the Namespace URI for this QName \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getPrefix](#getPrefix())()`Gets the Prefix for this QName \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getQualifiedName](#getQualifiedName())()`Returns the fully qualified name of this QName \| \| \| `public int` \| `[hashCode](#hashCode())()`Returns a hash code value for this QName object. \| \| \| `public boolean` \| `[matches](#matches(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o)`Tests if this QName matches another object. \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[toString](#toString())()`Returns a string representation of this QName \| \| \| `public static [QName](qname)` \| `[valueOf](#valueOf(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") s)`Returns a QName holding the value of the specified String. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public QName([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") localPart) Constructor for the QName. Parameters: `localPart` - Local part of the QName ### public QName([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") namespaceURI, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") localPart) Constructor for the QName. Parameters: `namespaceURI` - Namespace URI for the QName `localPart` - Local part of the QName. ### public QName([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") namespaceURI, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") localPart, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") prefix) Constructor for the QName. Parameters: `namespaceURI` - Namespace URI for the QName `localPart` - Local part of the QName. `prefix` - Prefix of the QName. Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public boolean equals([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o) Tests this QName for equality with another object. If the given object is not a QName or String equivalent or is null then this method returns false. For two QNames to be considered equal requires that both localPart and namespaceURI must be equal. This method uses `String.equals` to check equality of localPart and namespaceURI. Any class that extends QName is required to satisfy this equality contract. If the supplied object is a String, then it is split in two on the last colon and the first half is compared against the prefix \|\| namespaceURI and the second half is compared against the localPart i.e. assert new QName("namespace","localPart").equals("namespace:localPart") Intended Usage: for gpath accessors, e.g. root.'urn:mynamespace:node' Warning: this equivalence is not commutative, i.e. qname.equals(string) may be true/false but string.equals(qname) is always false This method satisfies the general contract of the `Object.equals` method. Parameters: `o` - the reference object with which to compare Returns: `true` if the given object is identical to this QName: `false` otherwise. ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getLocalPart() Gets the Local part for this QName Returns: Local part ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getNamespaceURI() Gets the Namespace URI for this QName Returns: Namespace URI ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getPrefix() Gets the Prefix for this QName Returns: Prefix ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getQualifiedName() Returns the fully qualified name of this QName Returns: a string representation of the QName ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public int hashCode() Returns a hash code value for this QName object. The hash code is based on both the localPart and namespaceURI parts of the QName. This method satisfies the general contract of the `Object.hashCode` method. Returns: a hash code value for this Qname object ### public boolean matches([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") o) Tests if this QName matches another object. If the given object is not a QName or String equivalent or is null then this method returns false. For two QNames to be considered matching requires that both localPart and namespaceURI must be equal or one of them is a wildcard. If the supplied object is a String, then it is split in two on the last colon and the first half is matched against the prefix \|\| namespaceURI and the second half is matched against the localPart Parameters: `o` - the reference object with which to compare Returns: `true` if the given object matches this QName: `false` otherwise. ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") toString() Returns a string representation of this QName Returns: a string representation of the QName ### public static [QName](qname) valueOf([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") s) Returns a QName holding the value of the specified String. The string must be in the form returned by the QName.toString() method, i.e. "{namespaceURI}localPart", with the "{namespaceURI}" part being optional. This method doesn't do a full validation of the resulting QName. In particular, it doesn't check that the resulting namespace URI is a legal URI (per RFC 2396 and RFC 2732), nor that the resulting local part is a legal NCName per the XML Namespaces specification. throws: java.lang.IllegalArgumentException If the specified String cannot be parsed as a QName Parameters: `s` - the string to be parsed Returns: QName corresponding to the given String groovy [Java] Class TypedOption<T> [Java] Class TypedOption<T> =========================== * groovy.cli.TypedOption ``` public class TypedOption<T> extends [HashMap](https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html "HashMap") ``` Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public T` \| `[defaultValue](#defaultValue())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [HashMap](https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html "HashMap")` \| `[remove](https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html#remove(java.lang.Object,%20java.lang.Object) "remove"), [remove](https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html#remove(java.lang.Object) "remove"), [get](https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html#get(java.lang.Object) "get"), [put](https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html#put(java.lang.Object,%20java.lang.Object) "put"), [values](https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html#values() "values"), [clone](https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html#clone() "clone"), [clear](https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html#clear() "clear"), [isEmpty](https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html#isEmpty() "isEmpty"), [replace](https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html#replace(java.lang.Object,%20java.lang.Object) "replace"), [replace](https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html#replace(java.lang.Object,%20java.lang.Object,%20java.lang.Object) "replace"), [replaceAll](https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html#replaceAll(java.util.function.BiFunction) "replaceAll"), [size](https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html#size() "size"), [merge](https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html#merge(java.lang.Object,%20java.lang.Object,%20java.util.function.BiFunction) "merge"), [entrySet](https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html#entrySet() "entrySet"), [putAll](https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html#putAll(java.util.Map) "putAll"), [putIfAbsent](https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html#putIfAbsent(java.lang.Object,%20java.lang.Object) "putIfAbsent"), [compute](https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html#compute(java.lang.Object,%20java.util.function.BiFunction) "compute"), [forEach](https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html#forEach(java.util.function.BiConsumer) "forEach"), [containsKey](https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html#containsKey(java.lang.Object) "containsKey"), [computeIfAbsent](https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html#computeIfAbsent(java.lang.Object,%20java.util.function.Function) "computeIfAbsent"), [keySet](https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html#keySet() "keySet"), [containsValue](https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html#containsValue(java.lang.Object) "containsValue"), [getOrDefault](https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html#getOrDefault(java.lang.Object,%20java.lang.Object) "getOrDefault"), [computeIfPresent](https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html#computeIfPresent(java.lang.Object,%20java.util.function.BiFunction) "computeIfPresent"), [equals](https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html#hashCode() "hashCode"), [wait](https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html#wait(long) "wait"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### public T defaultValue() groovy [Java] Annotation Type Option [Java] Annotation Type Option ============================= * groovy.cli.Option ``` @[Documented](https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Documented.html "Documented") @[Retention](https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html "Retention")(RetentionPolicy.RUNTIME) @[Target](https://docs.groovy-lang.org/docs/ant/api/org/apache/tools/ant/Target.html "Target")({ElementType.METHOD, ElementType.FIELD}) public @interface Option ``` Indicates that a method or property can be used to set a CLI option. Element Summary --------------- Optional Element Summary \| Type \| Name and Description \| \| `[Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")` \| `[convert](#convert)`A conversion closure to convert the incoming String into the desired object \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[defaultValue](#defaultValue)`The default value for this option as a String; subject to type conversion and 'convert'. \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[description](#description)`The description of this option \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[longName](#longName)`The long name of this option. \| \| `int` \| `[numberOfArguments](#numberOfArguments)`How many arguments this option has. \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[numberOfArgumentsString](#numberOfArgumentsString)`How many arguments this option has represented as a String. \| \| `boolean` \| `[optionalArg](#optionalArg)`Whether this option can have an optional argument. \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[shortName](#shortName)`The short name of this option. \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[valueSeparator](#valueSeparator)`The value separator for this multi-valued option. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Element Detail -------------- ### public [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") convert A conversion closure to convert the incoming String into the desired object Returns: the closure to convert this option's argument(s) Default: Undefined.CLASS.class ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") defaultValue The default value for this option as a String; subject to type conversion and 'convert'. Ignored for Boolean options. Returns: the default value for this option Default: "" ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") description The description of this option Returns: the description of this option Default: "" ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") longName The long name of this option. Defaults to the name of member being annotated. Returns: the long name of this option Default: "" ### public int numberOfArguments How many arguments this option has. A value greater than 1 is only allowed for array-typed arguments. Ignored for boolean options which are assumed to have a default of 0 or if `numberOfArgumentsString` is set. Returns: the number of arguments Default: 1 ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") numberOfArgumentsString How many arguments this option has represented as a String. Only allowed for array-typed arguments. Overrides `numberOfArguments` if set. The special values of '+' means one or more and '\' as 0 or more. Returns:* the number of arguments (as a String) Default: "" ### public boolean optionalArg Whether this option can have an optional argument. Only supported for array-typed arguments to indicate that the array may be empty. Returns: true if this array-typed option can have an optional argument (i.e. could be empty) Default: false ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") shortName The short name of this option. Defaults to the name of member being annotated if the longName is empty. Returns: the short name of this option Default: "" ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") valueSeparator The value separator for this multi-valued option. Only allowed for array-typed arguments. Returns: the value separator for this multi-valued option Default: ""	programming_docs
groovy [Groovy] Annotation Type UnparsedField [Groovy] Annotation Type UnparsedField ====================================== * groovy.cli.UnparsedField All Implemented Interfaces and Traits: [Annotation](https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Annotation.html "Annotation") ``` @[Unparsed](unparsed "Unparsed") @[Field](../transform/field "Field") @[AnnotationCollector](../transform/annotationcollector "AnnotationCollector") @interface UnparsedField ``` Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| groovy [Groovy] Annotation Type OptionField [Groovy] Annotation Type OptionField ==================================== * groovy.cli.OptionField All Implemented Interfaces and Traits: [Annotation](https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Annotation.html "Annotation") ``` @[Option](option "Option") @[Field](../transform/field "Field") @[AnnotationCollector](../transform/annotationcollector "AnnotationCollector") @interface OptionField ``` Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| groovy [Java] Annotation Type Unparsed [Java] Annotation Type Unparsed =============================== * groovy.cli.Unparsed ``` @[Documented](https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Documented.html "Documented") @[Retention](https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html "Retention")(RetentionPolicy.RUNTIME) @[Target](https://docs.groovy-lang.org/docs/ant/api/org/apache/tools/ant/Target.html "Target")({ElementType.METHOD, ElementType.FIELD}) public @interface Unparsed ``` Indicates that a method or property will contain the remaining arguments. Element Summary --------------- Optional Element Summary \| Type \| Name and Description \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[description](#description)`The description for the remaining non-option arguments \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Element Detail -------------- ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") description The description for the remaining non-option arguments Returns: the description for the remaining non-option arguments Default: "ARGUMENTS" groovy [Groovy] Class CliBuilderException [Groovy] Class CliBuilderException ================================== * groovy.cli.CliBuilderException ``` @[InheritConstructors](../transform/inheritconstructors "InheritConstructors") class CliBuilderException extends [RuntimeException](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html "RuntimeException") ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[CliBuilderException](#CliBuilderException())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [RuntimeException](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html "RuntimeException")` \| `[printStackTrace](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html#printStackTrace() "printStackTrace"), [printStackTrace](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html#printStackTrace(java.io.PrintStream) "printStackTrace"), [printStackTrace](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html#printStackTrace(java.io.PrintWriter) "printStackTrace"), [fillInStackTrace](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html#fillInStackTrace() "fillInStackTrace"), [getCause](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html#getCause() "getCause"), [initCause](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html#initCause(java.lang.Throwable) "initCause"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html#toString() "toString"), [getMessage](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html#getMessage() "getMessage"), [getSuppressed](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html#getSuppressed() "getSuppressed"), [getLocalizedMessage](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html#getLocalizedMessage() "getLocalizedMessage"), [getStackTrace](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html#getStackTrace() "getStackTrace"), [setStackTrace](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html#setStackTrace(%5BLjava.lang.StackTraceElement;) "setStackTrace"), [addSuppressed](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html#addSuppressed(java.lang.Throwable) "addSuppressed"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html#equals(java.lang.Object) "equals"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### CliBuilderException() groovy [Groovy] Class OptionAccessor [Groovy] Class OptionAccessor ============================= * groovy.cli.commons.OptionAccessor ``` class OptionAccessor extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Properties Summary ------------------ Properties \| Type \| Name and description \| \| `[CommandLine](https://commons.apache.org/proper/commons-cli/javadocs/api-release/org/apache/commons/cli/CommandLine.html "CommandLine")` \| `[commandLine](#commandLine)` \| \| `[Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), TypedOption>` \| `[savedTypeOptions](#savedTypeOptions)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[OptionAccessor](#OptionAccessor(org.apache.commons.cli.CommandLine))([CommandLine](https://commons.apache.org/proper/commons-cli/javadocs/api-release/org/apache/commons/cli/CommandLine.html "CommandLine") commandLine)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>` \| `[arguments](#arguments())()` \| \| `<T>` \| `T` \| `[defaultValue](#defaultValue(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name)` \| \| `<T>` \| `T` \| `[getAt](#getAt(TypedOption))(TypedOption<T> typedOption)` \| \| `<T>` \| `T` \| `[getAt](#getAt(TypedOption,%20T))(TypedOption<T> typedOption, T defaultValue)` \| \| `<T>` \| `T` \| `[getOptionValue](#getOptionValue(TypedOption))(TypedOption<T> typedOption)` \| \| `<T>` \| `T` \| `[getOptionValue](#getOptionValue(TypedOption,%20T))(TypedOption<T> typedOption, T defaultValue)` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getProperty](#getProperty(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name)` \| \| \| `boolean` \| `[hasOption](#hasOption(groovy.cli.TypedOption))([TypedOption](../typedoption) typedOption)` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[invokeMethod](#invokeMethod(java.lang.String,%20java.lang.Object))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Property Detail --------------- ### [CommandLine](https://commons.apache.org/proper/commons-cli/javadocs/api-release/org/apache/commons/cli/CommandLine.html "CommandLine") commandLine ### [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), TypedOption> savedTypeOptions Constructor Detail ------------------ ### OptionAccessor([CommandLine](https://commons.apache.org/proper/commons-cli/javadocs/api-release/org/apache/commons/cli/CommandLine.html "CommandLine") commandLine) Method Detail ------------- ### [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> arguments() ### <T> T defaultValue([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name) ### <T> T getAt(TypedOption<T> typedOption) ### <T> T getAt(TypedOption<T> typedOption, T defaultValue) ### <T> T getOptionValue(TypedOption<T> typedOption) ### <T> T getOptionValue(TypedOption<T> typedOption, T defaultValue) ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getProperty([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name) ### boolean hasOption([TypedOption](../typedoption) typedOption) ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") invokeMethod([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args) groovy [Groovy] Class CliBuilder [Groovy] Class CliBuilder ========================= * groovy.cli.commons.CliBuilder ``` class CliBuilder extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Provides a builder to assist the processing of command line arguments. Two styles are supported: dynamic api style (declarative method calls provide a mini DSL for describing options) and annotation style (annotations on an interface or class describe options). Dynamic api style Typical usage (emulate partial arg processing of unix command: ls -alt \.groovy): ``` def cli = new CliBuilder(usage:'ls') cli.a('display all files') cli.l('use a long listing format') cli.t('sort by modification time') def options = cli.parse(args) assert options // would be null (false) on failure assert options.arguments() == ['.groovy'] assert options.a && options.l && options.t ``` The usage message for this example (obtained using `cli.usage()`) is shown below: ``` usage: ls -a display all files -l use a long listing format -t sort by modification time ``` An underlying parser that supports what is called argument 'bursting' is used by default. Bursting would convert '-alt' into '-a -l -t' provided no long option exists with value 'alt' and provided that none of 'a', 'l' or 't' takes an argument (in fact the last one is allowed to take an argument). The bursting behavior can be turned off by using an alternate underlying parser. The simplest way to achieve this is by using the deprecated GnuParser from Commons CLI with the parser property on the CliBuilder, i.e. include `parser: new GnuParser()` in the constructor call. Another example (partial emulation of arg processing for 'ant' command line): ``` def cli = new CliBuilder(usage:'ant [options] [targets]', header:'Options:') cli.help('print this message') cli.logfile(args:1, argName:'file', 'use given file for log') cli.D(args:2, valueSeparator:'=', argName:'property=value', 'use value for given property') def options = cli.parse(args) ... ``` Usage message would be: ``` usage: ant [options] [targets] Options: -D <property=value> use value for given property -help print this message -logfile <file> use given file for log ``` And if called with the following arguments '-logfile foo -Dbar=baz target' then the following assertions would be true: ``` assert options // would be null (false) on failure assert options.arguments() == ['target'] assert options.Ds == ['bar', 'baz'] assert options.logfile == 'foo' ``` Note the use of some special notation. By adding 's' onto an option that may appear multiple times and has an argument or as in this case uses a valueSeparator to separate multiple argument values causes the list of associated argument values to be returned. Another example showing long options (partial emulation of arg processing for 'curl' command line): ``` def cli = new CliBuilder(usage:'curl [options] <url>') cli._(longOpt:'basic', 'Use HTTP Basic Authentication') cli.d(longOpt:'data', args:1, argName:'data', 'HTTP POST data') cli.G(longOpt:'get', 'Send the -d data with a HTTP GET') cli.q('If used as the first parameter disables .curlrc') cli._(longOpt:'url', args:1, argName:'URL', 'Set URL to work with') ``` Which has the following usage message: ``` usage: curl [options] <url> --basic Use HTTP Basic Authentication -d,--data <data> HTTP POST data -G,--get Send the -d data with a HTTP GET -q If used as the first parameter disables .curlrc --url <URL> Set URL to work with ``` This example shows a common convention. When mixing short and long names, the short names are often one character in size. One character options with arguments don't require a space between the option and the argument, e.g. `-Ddebug=true`. The example also shows the use of '\_' when no short option is applicable. Also note that '\_' was used multiple times. This is supported but if any other shortOpt or any longOpt is repeated, then the behavior is undefined. Short option names may not contain a hyphen. If a long option name contains a hyphen, e.g. '--max-wait' then you can either use the long hand method call `options.hasOption('max-wait')` or surround the option name in quotes, e.g. `options.'max-wait'`. Although CliBuilder on the whole hides away the underlying library used for processing the arguments, it does provide some hooks which let you make use of the underlying library directly should the need arise. For example, the last two lines of the 'curl' example above could be replaced with the following: ``` import org.apache.commons.cli.* ... as before ... cli << new Option('q', false, 'If used as the first parameter disables .curlrc') cli << Option.builder().longOpt('url').hasArg().argName('URL'). desc('Set URL to work with').build() ... ``` CliBuilder also supports Argument File processing. If an argument starts with an '@' character followed by a filename, then the contents of the file with name filename are placed into the command line. The feature can be turned off by setting expandArgumentFiles to false. If turned on, you can still pass a real parameter with an initial '@' character by escaping it with an additional '@' symbol, e.g. '@@foo' will become '@foo' and not be subject to expansion. As an example, if the file temp.args contains the content: ``` -arg1 paramA paramB paramC ``` Then calling the command line with: ``` someCommand ``` temp.args: -arg2 paramD Is the same as calling this: ``` someCommand -arg1 paramA paramB paramC -arg2 paramD ``` This feature is particularly useful on operating systems which place limitations on the size of the command line (e.g. Windows). The feature is similar to the 'Command Line Argument File' processing supported by javadoc and javac. Consult the corresponding documentation for those tools if you wish to see further examples. Supported Option Properties: ``` argName: String longOpt: String args: int or String optionalArg: boolean required: boolean type: Class valueSeparator: char convert: Closure defaultValue: String ``` See [Option](https://commons.apache.org/proper/commons-cli/javadocs/api-release/org/apache/commons/cli/Option.html "Option") for the meaning of most of these properties and CliBuilderTest for further examples. Annotation style with an interface With this style an interface is defined containing an annotated method for each option. It might look like this (following roughly the earlier 'ls' example): ``` import groovy.cli.Option import groovy.cli.Unparsed interface OptionInterface { ``` @[Option](../option "Option")(shortName='a', description='display all files') boolean all() @[Option](../option "Option")(shortName='l', description='use a long listing format') boolean longFormat() @[Option](../option "Option")(shortName='t', description='sort by modification time') boolean time() @[Unparsed](../unparsed "Unparsed") List remaining() } Then this description is supplied to CliBuilder during parsing, e.g.: ``` def args = '-alt .groovy'.split() // normally from commandline itself def cli = new CliBuilder(usage:'ls') def options = cli.parseFromSpec(OptionInterface, args) assert options.remaining() == ['.groovy'] assert options.all() && options.longFormat() && options.time() ``` Annotation style with a class With this style a user-supplied instance is used. Annotations on that instance's class members (properties and setter methods) indicate how to set options and provide the option details using annotation attributes. It might look like this (again using the earlier 'ls' example): ``` import groovy.cli.Option import groovy.cli.Unparsed class OptionClass { @[Option](../option "Option")(shortName='a', description='display all files') boolean all @[Option](../option "Option")(shortName='l', description='use a long listing format') boolean longFormat @[Option](../option "Option")(shortName='t', description='sort by modification time') boolean time @[Unparsed](../unparsed "Unparsed") List remaining } ``` Then this description is supplied to CliBuilder during parsing, e.g.: ``` def args = '-alt .groovy'.split() // normally from commandline itself def cli = new CliBuilder(usage:'ls') def options = new OptionClass() cli.parseFromInstance(options, args) assert options.remaining == ['.groovy'] assert options.all && options.longFormat && options.time ``` Properties Summary ------------------ Properties \| Type \| Name and description \| \| `boolean` \| `[expandArgumentFiles](#expandArgumentFiles)`Whether arguments of the form '`@`filename' will be expanded into the arguments contained within the file named filename (default true). \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[footer](#footer)`Optional additional message for usage; displayed after the options are displayed. \| \| `[HelpFormatter](https://commons.apache.org/proper/commons-cli/javadocs/api-release/org/apache/commons/cli/HelpFormatter.html "HelpFormatter")` \| `[formatter](#formatter)`Normally set internally but can be overridden if you want to customise how the usage message is displayed. \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[header](#header)`Optional additional message for usage; displayed after the usage summary but before the options are displayed. \| \| `[Options](https://commons.apache.org/proper/commons-cli/javadocs/api-release/org/apache/commons/cli/Options.html "Options")` \| `[options](#options)`Not normally accessed directly but full access to underlying options if needed. \| \| `[CommandLineParser](https://commons.apache.org/proper/commons-cli/javadocs/api-release/org/apache/commons/cli/CommandLineParser.html "CommandLineParser")` \| `[parser](#parser)`Normally set internally but allows you full customisation of the underlying processing engine. \| \| `[Boolean](https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html "Boolean")` \| `[posix](#posix)`To change from the default PosixParser to the GnuParser, set this to false. \| \| `[Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), TypedOption>` \| `[savedTypeOptions](#savedTypeOptions)` \| \| `boolean` \| `[stopAtNonOption](#stopAtNonOption)`Indicates that option processing should continue for all arguments even if arguments not recognized as options are encountered (default true). \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[usage](#usage)`Usage summary displayed as the first line when `cli.usage()` is called. \| \| `int` \| `[width](#width)`Allows customisation of the usage message width. \| \| `[PrintWriter](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html "PrintWriter")` \| `[writer](#writer)`Defaults to stdout but you can provide your own PrintWriter if desired. \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[CliBuilder](#CliBuilder())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `void` \| `[addOptionsFromAnnotations](#addOptionsFromAnnotations(java.lang.Class,%20boolean))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") optionClass, boolean namesAreSetters)` \| \| \| `static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")` \| `[adjustDetails](#adjustDetails(java.util.Map))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") m)` \| \| \| `static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[expandArgumentFiles](#expandArgumentFiles(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args)` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[invokeMethod](#invokeMethod(java.lang.String,%20java.lang.Object))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args)`Internal method: Detect option specification method calls. \| \| `<T>` \| `TypedOption<T>` \| `[option](#option(java.util.Map,%20Class,%20java.lang.String))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") args, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<T> type, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") description)` \| \| \| `[Option](https://commons.apache.org/proper/commons-cli/javadocs/api-release/org/apache/commons/cli/Option.html "Option")` \| `[option](#option(java.lang.Object,%20java.util.Map,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") shortname, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") details, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") info)`Internal method: How to create an option from the specification. \| \| \| `[OptionAccessor](optionaccessor)` \| `[parse](#parse(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args)`Make options accessible from command line args with parser. \| \| `<T>` \| `T` \| `[parseFromInstance](#parseFromInstance(T,%20java.lang.Object))(T optionInstance, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args)`Given an instance containing members with annotations, derive the options specification. \| \| `<T>` \| `T` \| `[parseFromSpec](#parseFromSpec(Class,%20java.lang.String))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<T> optionsClass, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")[] args)`Given an interface containing members with annotations, derive the options specification. \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[setOptionsFromAnnotations](#setOptionsFromAnnotations(java.lang.Object,%20java.lang.Class,%20java.lang.Object,%20boolean))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") cli, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") optionClass, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") t, boolean namesAreSetters)` \| \| \| `void` \| `[usage](#usage())()`Print the usage message with writer (default: System.out) and formatter (default: HelpFormatter) \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Property Detail --------------- ### boolean expandArgumentFiles Whether arguments of the form '`@`filename' will be expanded into the arguments contained within the file named filename (default true). ### [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") footer Optional additional message for usage; displayed after the options are displayed. ### [HelpFormatter](https://commons.apache.org/proper/commons-cli/javadocs/api-release/org/apache/commons/cli/HelpFormatter.html "HelpFormatter") formatter Normally set internally but can be overridden if you want to customise how the usage message is displayed. ### [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") header Optional additional message for usage; displayed after the usage summary but before the options are displayed. ### [Options](https://commons.apache.org/proper/commons-cli/javadocs/api-release/org/apache/commons/cli/Options.html "Options") options Not normally accessed directly but full access to underlying options if needed. ### [CommandLineParser](https://commons.apache.org/proper/commons-cli/javadocs/api-release/org/apache/commons/cli/CommandLineParser.html "CommandLineParser") parser Normally set internally but allows you full customisation of the underlying processing engine. ### @[Deprecated](https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html "Deprecated") [Boolean](https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html "Boolean") posix To change from the default PosixParser to the GnuParser, set this to false. Ignored if the parser is explicitly set. deprecated: use the parser option instead with an instance of your preferred parser ### [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), TypedOption> savedTypeOptions ### boolean stopAtNonOption Indicates that option processing should continue for all arguments even if arguments not recognized as options are encountered (default true). ### [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") usage Usage summary displayed as the first line when `cli.usage()` is called. ### int width Allows customisation of the usage message width. ### [PrintWriter](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html "PrintWriter") writer Defaults to stdout but you can provide your own PrintWriter if desired. Constructor Detail ------------------ ### CliBuilder() Method Detail ------------- ### void addOptionsFromAnnotations([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") optionClass, boolean namesAreSetters) ### static [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") adjustDetails([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") m) ### static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") expandArgumentFiles([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args) ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") invokeMethod([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args) Internal method: Detect option specification method calls. ### <T> TypedOption<T> option([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") args, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<T> type, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") description) ### [Option](https://commons.apache.org/proper/commons-cli/javadocs/api-release/org/apache/commons/cli/Option.html "Option") option([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") shortname, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") details, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") info) Internal method: How to create an option from the specification. ### [OptionAccessor](optionaccessor) parse([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args) Make options accessible from command line args with parser. Returns null on bad command lines after displaying usage message. ### <T> T parseFromInstance(T optionInstance, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args) Given an instance containing members with annotations, derive the options specification. Parameters: optionInstance args Returns: the options instance populated with the processed options ### <T> T parseFromSpec([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<T> optionsClass, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")[] args) Given an interface containing members with annotations, derive the options specification. Parameters: optionsClass args Returns: an instance containing the processed options ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") setOptionsFromAnnotations([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") cli, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class") optionClass, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") t, boolean namesAreSetters) ### void usage() Print the usage message with writer (default: System.out) and formatter (default: HelpFormatter)	programming_docs
groovy [Groovy] Class CliBuilderInternal [Groovy] Class CliBuilderInternal ================================= * groovy.cli.internal.CliBuilderInternal ``` class CliBuilderInternal extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Cut-down version of CliBuilder with just enough functionality for Groovy's internal usage. Uses the embedded version of picocli classes. TODO: prune this right back to have only the functionality needed by Groovy commandline tools Properties Summary ------------------ Properties \| Type \| Name and description \| \| `boolean` \| `[acceptLongOptionsWithSingleHyphen](#acceptLongOptionsWithSingleHyphen)`For backwards compatibility with Apache Commons CLI, set this property to `true` if the parser should recognize long options with both a single hyphen and a double hyphen prefix. \| \| `[PrintWriter](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html "PrintWriter")` \| `[errorWriter](#errorWriter)`The PrintWriter to write to when invalid user input was provided to the [parse(java.lang.String[])](#parse(java.lang.String)) method. \| \| `boolean` \| `[expandArgumentFiles](#expandArgumentFiles)`Whether arguments of the form '`@`filename' will be expanded into the arguments contained within the file named filename (default true). \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[footer](#footer)`Optional additional message for usage; displayed after the options. \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[header](#header)`Optional additional message for usage; displayed after the usage summary but before the options are displayed. \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[name](#name)`This property allows customizing the program name displayed in the synopsis when `cli.usage()` is called. \| \| `[ParserSpec](../../../commandline/model.parserspec)` \| `[parser](#parser)` \| \| `[Boolean](https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html "Boolean")` \| `[posix](#posix)`To disallow clustered POSIX short options, set this to false. \| \| `[Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), TypedOption>` \| `[savedTypeOptions](#savedTypeOptions)`Internal data structure mapping option names to their associated [TypedOption](../typedoption "TypedOption") object. \| \| `boolean` \| `[stopAtNonOption](#stopAtNonOption)`Configures what the parser should do when arguments not recognized as options are encountered: when `true` (the default), the remaining arguments are all treated as positional parameters. \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[usage](#usage)`The command synopsis displayed as the first line in the usage help message, e.g., when `cli.usage()` is called. \| \| `[UsageMessageSpec](../../../commandline/model.usagemessagespec)` \| `[usageMessage](#usageMessage)` \| \| `int` \| `[width](#width)`Allows customisation of the usage message width. \| \| `[PrintWriter](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html "PrintWriter")` \| `[writer](#writer)`The PrintWriter to write the [usage](#usage) help message to when `cli.usage()` is called. \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[CliBuilderInternal](#CliBuilderInternal())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[invokeMethod](#invokeMethod(java.lang.String,%20java.lang.Object))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args)`Internal method: Detect option specification method calls. \| \| `<T>` \| `TypedOption<T>` \| `[option](#option(java.util.Map,%20Class,%20java.lang.String))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") args, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<T> type, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") description)` \| \| \| `[OptionSpec](../../../commandline/model.optionspec)` \| `[option](#option(java.lang.Object,%20java.util.Map,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") shortname, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") details, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") description)`Internal method: How to create an OptionSpec from the specification. \| \| \| `[OptionAccessor](optionaccessor)` \| `[parse](#parse(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args)`Make options accessible from command line args with parser. \| \| \| `void` \| `[setExpandArgumentFiles](#setExpandArgumentFiles(boolean))(boolean expand)`Sets the [expandArgumentFiles](#expandArgumentFiles) property on this `CliBuilder` and on the [parser](#parser) used by the underlying library. \| \| \| `void` \| `[setFooter](#setFooter(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") footer)`Sets the [footer](#footer) property on this `CliBuilder` and on the [usageMessage](#usageMessage) used by the underlying library. \| \| \| `void` \| `[setHeader](#setHeader(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") header)`Sets the [header](#header) property on this `CliBuilder` and the `description` on the [usageMessage](#usageMessage) used by the underlying library. \| \| \| `void` \| `[setPosix](#setPosix(java.lang.Boolean))([Boolean](https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html "Boolean") posix)`Sets the [posix](#posix) property on this `CliBuilder` and the `posixClusteredShortOptionsAllowed` property on the [parser](#parser) used by the underlying library. \| \| \| `void` \| `[setStopAtNonOption](#setStopAtNonOption(boolean))(boolean stopAtNonOption)`Sets the [stopAtNonOption](#stopAtNonOption) property on this `CliBuilder` and the `stopAtPositional` property on the [parser](#parser) used by the underlying library. \| \| \| `void` \| `[setUsage](#setUsage(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") usage)`Sets the [usage](#usage) property on this `CliBuilder` and the `customSynopsis` on the [usageMessage](#usageMessage) used by the underlying library. \| \| \| `void` \| `[setWidth](#setWidth(int))(int width)`Sets the [width](#width) property on this `CliBuilder` and on the [usageMessage](#usageMessage) used by the underlying library. \| \| \| `void` \| `[setWriter](#setWriter(java.io.PrintWriter))([PrintWriter](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html "PrintWriter") writer)`For backwards compatibility reasons, if a custom `writer` is set, this sets both the [writer](#writer) and the [errorWriter](#errorWriter) to the specified writer. \| \| \| `void` \| `[usage](#usage())()`Prints the usage message with the specified [header](#header), [footer](#footer) and [width](#width) to the specified [writer](#writer) (default: System.out). \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Property Detail --------------- ### boolean acceptLongOptionsWithSingleHyphen For backwards compatibility with Apache Commons CLI, set this property to `true` if the parser should recognize long options with both a single hyphen and a double hyphen prefix. The default is `false`, so only long options with a double hypen prefix (`--option`) are recognized. Since: 2.5 ### [PrintWriter](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html "PrintWriter") errorWriter The PrintWriter to write to when invalid user input was provided to the [parse(java.lang.String[])](#parse(java.lang.String)) method. Defaults to stderr but you can provide your own PrintWriter if desired. Since: 2.5 ### boolean expandArgumentFiles Whether arguments of the form '`@`filename' will be expanded into the arguments contained within the file named filename (default true). ### [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") footer Optional additional message for usage; displayed after the options. ### [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") header Optional additional message for usage; displayed after the usage summary but before the options are displayed. ### [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name This property allows customizing the program name displayed in the synopsis when `cli.usage()` is called. Ignored if the [usage](#usage) property is set. Since: 2.5 ### final [ParserSpec](../../../commandline/model.parserspec) parser ### [Boolean](https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html "Boolean") posix To disallow clustered POSIX short options, set this to false. ### [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), TypedOption> savedTypeOptions Internal data structure mapping option names to their associated [TypedOption](../typedoption "TypedOption") object. ### boolean stopAtNonOption Configures what the parser should do when arguments not recognized as options are encountered: when `true` (the default), the remaining arguments are all treated as positional parameters. When `false`, the parser will continue to look for options, and only the unrecognized arguments are treated as positional parameters. ### [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") usage The command synopsis displayed as the first line in the usage help message, e.g., when `cli.usage()` is called. When not set, a default synopsis is generated that shows the supported options and parameters. See Also: [name](#name) ### final [UsageMessageSpec](../../../commandline/model.usagemessagespec) usageMessage ### int width Allows customisation of the usage message width. ### [PrintWriter](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html "PrintWriter") writer The PrintWriter to write the [usage](#usage) help message to when `cli.usage()` is called. Defaults to stdout but you can provide your own PrintWriter if desired. Constructor Detail ------------------ ### CliBuilderInternal() Method Detail ------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") invokeMethod([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args) Internal method: Detect option specification method calls. ### <T> TypedOption<T> option([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") args, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<T> type, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") description) ### [OptionSpec](../../../commandline/model.optionspec) option([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") shortname, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") details, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") description) Internal method: How to create an OptionSpec from the specification. ### [OptionAccessor](optionaccessor) parse([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args) Make options accessible from command line args with parser. Returns null on bad command lines after displaying usage message. ### void setExpandArgumentFiles(boolean expand) Sets the [expandArgumentFiles](#expandArgumentFiles) property on this `CliBuilder` and on the [parser](#parser) used by the underlying library. @-files Parameters: `expand` - whether to expand argument ### void setFooter([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") footer) Sets the [footer](#footer) property on this `CliBuilder` and on the [usageMessage](#usageMessage) used by the underlying library. Parameters: `footer` - the footer of the usage help message ### void setHeader([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") header) Sets the [header](#header) property on this `CliBuilder` and the `description` on the [usageMessage](#usageMessage) used by the underlying library. Parameters: `header` - the description text of the usage help message ### void setPosix([Boolean](https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html "Boolean") posix) Sets the [posix](#posix) property on this `CliBuilder` and the `posixClusteredShortOptionsAllowed` property on the [parser](#parser) used by the underlying library. Parameters: `posix` - whether to allow clustered short options ### void setStopAtNonOption(boolean stopAtNonOption) Sets the [stopAtNonOption](#stopAtNonOption) property on this `CliBuilder` and the `stopAtPositional` property on the [parser](#parser) used by the underlying library. Parameters: `stopAtNonOption` - when `true` (the default), the remaining arguments are all treated as positional parameters. When `false`, the parser will continue to look for options, and only the unrecognized arguments are treated as positional parameters. ### void setUsage([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") usage) Sets the [usage](#usage) property on this `CliBuilder` and the `customSynopsis` on the [usageMessage](#usageMessage) used by the underlying library. Parameters: `usage` - the custom synopsis of the usage help message ### void setWidth(int width) Sets the [width](#width) property on this `CliBuilder` and on the [usageMessage](#usageMessage) used by the underlying library. Parameters: `width` - the width of the usage help message ### void setWriter([PrintWriter](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html "PrintWriter") writer) For backwards compatibility reasons, if a custom `writer` is set, this sets both the [writer](#writer) and the [errorWriter](#errorWriter) to the specified writer. Parameters: `writer` - the writer to initialize both the `writer` and the `errorWriter` to ### void usage() Prints the usage message with the specified [header](#header), [footer](#footer) and [width](#width) to the specified [writer](#writer) (default: System.out). groovy [Groovy] Class OptionAccessor [Groovy] Class OptionAccessor ============================= * groovy.cli.internal.OptionAccessor ``` class OptionAccessor extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Properties Summary ------------------ Properties \| Type \| Name and description \| \| `[CommandLine.ParseResult](https://picocli.info/apidocs/picocli/CommandLine.ParseResult.html "CommandLine.ParseResult")` \| `[parseResult](#parseResult)` \| \| `[Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), TypedOption>` \| `[savedTypeOptions](#savedTypeOptions)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[OptionAccessor](#OptionAccessor(picocli.CommandLine%24ParseResult))([CommandLine.ParseResult](https://picocli.info/apidocs/picocli/CommandLine.ParseResult.html "CommandLine.ParseResult") parseResult)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>` \| `[arguments](#arguments())()` \| \| `<T>` \| `T` \| `[defaultValue](#defaultValue(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name)` \| \| `<T>` \| `T` \| `[getAt](#getAt(TypedOption))(TypedOption<T> typedOption)` \| \| `<T>` \| `T` \| `[getAt](#getAt(TypedOption,%20T))(TypedOption<T> typedOption, T defaultValue)` \| \| \| `[Properties](https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html "Properties")` \| `[getOptionProperties](#getOptionProperties(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name)` \| \| `<T>` \| `T` \| `[getOptionValue](#getOptionValue(TypedOption))(TypedOption<T> typedOption)` \| \| `<T>` \| `T` \| `[getOptionValue](#getOptionValue(TypedOption,%20T))(TypedOption<T> typedOption, T defaultValue)` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getProperty](#getProperty(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name)` \| \| \| `boolean` \| `[hasOption](#hasOption(groovy.cli.TypedOption))([TypedOption](../typedoption) typedOption)` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[invokeMethod](#invokeMethod(java.lang.String,%20java.lang.Object))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Property Detail --------------- ### [CommandLine.ParseResult](https://picocli.info/apidocs/picocli/CommandLine.ParseResult.html "CommandLine.ParseResult") parseResult ### [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), TypedOption> savedTypeOptions Constructor Detail ------------------ ### OptionAccessor([CommandLine.ParseResult](https://picocli.info/apidocs/picocli/CommandLine.ParseResult.html "CommandLine.ParseResult") parseResult) Method Detail ------------- ### [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> arguments() ### <T> T defaultValue([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name) ### <T> T getAt(TypedOption<T> typedOption) ### <T> T getAt(TypedOption<T> typedOption, T defaultValue) ### [Properties](https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html "Properties") getOptionProperties([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name) ### <T> T getOptionValue(TypedOption<T> typedOption) ### <T> T getOptionValue(TypedOption<T> typedOption, T defaultValue) ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getProperty([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name) ### boolean hasOption([TypedOption](../typedoption) typedOption) ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") invokeMethod([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args)	programming_docs
groovy [Groovy] Class OptionAccessor [Groovy] Class OptionAccessor ============================= * groovy.cli.picocli.OptionAccessor ``` class OptionAccessor extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Properties Summary ------------------ Properties \| Type \| Name and description \| \| `[CommandLine.ParseResult](https://picocli.info/apidocs/picocli/CommandLine.ParseResult.html "CommandLine.ParseResult")` \| `[parseResult](#parseResult)` \| \| `[Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), TypedOption>` \| `[savedTypeOptions](#savedTypeOptions)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[OptionAccessor](#OptionAccessor(picocli.CommandLine%24ParseResult))([CommandLine.ParseResult](https://picocli.info/apidocs/picocli/CommandLine.ParseResult.html "CommandLine.ParseResult") parseResult)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>` \| `[arguments](#arguments())()` \| \| `<T>` \| `T` \| `[defaultValue](#defaultValue(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name)` \| \| `<T>` \| `T` \| `[getAt](#getAt(TypedOption))(TypedOption<T> typedOption)` \| \| `<T>` \| `T` \| `[getAt](#getAt(TypedOption,%20T))(TypedOption<T> typedOption, T defaultValue)` \| \| \| `[Properties](https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html "Properties")` \| `[getOptionProperties](#getOptionProperties(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name)` \| \| `<T>` \| `T` \| `[getOptionValue](#getOptionValue(TypedOption))(TypedOption<T> typedOption)` \| \| `<T>` \| `T` \| `[getOptionValue](#getOptionValue(TypedOption,%20T))(TypedOption<T> typedOption, T defaultValue)` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getProperty](#getProperty(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name)` \| \| \| `boolean` \| `[hasOption](#hasOption(groovy.cli.TypedOption))([TypedOption](../typedoption) typedOption)` \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[invokeMethod](#invokeMethod(java.lang.String,%20java.lang.Object))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Property Detail --------------- ### [CommandLine.ParseResult](https://picocli.info/apidocs/picocli/CommandLine.ParseResult.html "CommandLine.ParseResult") parseResult ### [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), TypedOption> savedTypeOptions Constructor Detail ------------------ ### OptionAccessor([CommandLine.ParseResult](https://picocli.info/apidocs/picocli/CommandLine.ParseResult.html "CommandLine.ParseResult") parseResult) Method Detail ------------- ### [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> arguments() ### <T> T defaultValue([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name) ### <T> T getAt(TypedOption<T> typedOption) ### <T> T getAt(TypedOption<T> typedOption, T defaultValue) ### [Properties](https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html "Properties") getOptionProperties([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name) ### <T> T getOptionValue(TypedOption<T> typedOption) ### <T> T getOptionValue(TypedOption<T> typedOption, T defaultValue) ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getProperty([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name) ### boolean hasOption([TypedOption](../typedoption) typedOption) ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") invokeMethod([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args) groovy [Groovy] Class CliBuilder [Groovy] Class CliBuilder ========================= * groovy.cli.picocli.CliBuilder ``` class CliBuilder extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Provides a builder to assist the processing of command line arguments. Two styles are supported: dynamic api style (declarative method calls provide a mini DSL for describing options) and annotation style (annotations on an interface or class describe options). Dynamic api style Typical usage (emulate partial arg processing of unix command: ls -alt \.groovy): ``` def cli = new CliBuilder(name:'ls') cli.a('display all files') cli.l('use a long listing format') cli.t('sort by modification time') def options = cli.parse(args) assert options // would be null (false) on failure assert options.arguments() == ['.groovy'] assert options.a && options.l && options.t ``` The usage message for this example (obtained using `cli.usage()`) is shown below: ``` Usage: ls [-alt] -a display all files -l use a long listing format -t sort by modification time ``` An underlying parser that supports what is called argument 'bursting' is used by default. Bursting would convert '-alt' into '-a -l -t' provided no long option exists with value 'alt' and provided that none of 'a', 'l' or 't' takes an argument (in fact the last one is allowed to take an argument). The bursting behavior can be turned off by configuring the underlying parser. The simplest way to achieve this is by setting the posix property on the CliBuilder to false, i.e. include `posix: false` in the constructor call. Another example (partial emulation of arg processing for 'ant' command line): ``` def cli = new CliBuilder(usage:'ant [options] [targets]', header:'Options:') cli.help('print this message') cli.logfile(type:File, argName:'file', 'use given file for log') cli.D(type:Map, argName:'property=value', 'use value for given property') cli.lib(argName:'path', valueSeparator:',', args: '3', 'comma-separated list of 3 paths to search for jars and classes') def options = cli.parse(args) ... ``` Usage message would be: ``` Usage: ant [options] [targets] Options: -D= <property=value> use value for given property -help print this message -lib=<path>,<path>,<path> comma-separated list of 3 paths to search for jars and classes -logfile=<file> use given file for log ``` And if called with the following arguments '-logfile foo -Dbar=baz -lib=/tmp,/usr/lib,~/libs target' then the following assertions would be true: ``` assert options // would be null (false) on failure assert options.arguments() == ['target'] assert options.D == ['bar': 'baz'] assert options.libs == ['/tmp', '/usr/lib', '~/libs'] assert options.lib == '/tmp' assert options.logfile == new File('foo') ``` Note the use of some special notation. By adding 's' onto an option that may appear multiple times and has an argument or as in this case uses a valueSeparator to separate multiple argument values causes the list of associated argument values to be returned. Another example showing long options (partial emulation of arg processing for 'curl' command line): ``` def cli = new CliBuilder(name:'curl') cli._(longOpt:'basic', 'Use HTTP Basic Authentication') cli.d(longOpt:'data', args:1, argName:'data', 'HTTP POST data') cli.G(longOpt:'get', 'Send the -d data with a HTTP GET') cli.q('If used as the first parameter disables .curlrc') cli._(longOpt:'url', type:URL, argName:'URL', 'Set URL to work with') ``` Which has the following usage message: ``` Usage: curl [-Gq] [--basic] [--url=<URL>] [-d=<data>] --basic Use HTTP Basic Authentication -d, --data=<data> HTTP POST data -G, --get Send the -d data with a HTTP GET -q If used as the first parameter disables .curlrc --url=<URL> Set URL to work with ``` This example shows a common convention. When mixing short and long names, the short names are often one character in size. One character options with arguments don't require a space between the option and the argument, e.g. `-Ddebug=true`. The example also shows the use of '\_' when no short option is applicable. Also note that '\_' was used multiple times. This is supported but if any other shortOpt or any longOpt is repeated, then the underlying library throws an exception. Short option names may not contain a hyphen. If a long option name contains a hyphen, e.g. '--max-wait' then you can either use the long hand method call `options.hasOption('max-wait')` or surround the option name in quotes, e.g. `options.'max-wait'`. Although CliBuilder on the whole hides away the underlying library used for processing the arguments, it does provide some hooks which let you make use of the underlying library directly should the need arise. For example, the last two lines of the 'curl' example above could be replaced with the following: ``` import picocli.CommandLine.Model.* ... as before ... cli << OptionSpec.builder('-q'). description('If used as the first parameter disables .curlrc').build() cli << OptionSpec.builder('--url').type(URL.class).paramLabel('<URL>'). description('Set URL to work with').build() ... ``` As another example, the `usageMessage` property gives fine-grained control over the usage help message (see the [picocli user manual](http://picocli.info/#_usage_help_with_styles_and_colors) for details): ``` def cli = new CliBuilder() cli.name = "myapp" cli.usageMessage.with { headerHeading("@\|bold,underline Header heading:\|@%n") header("Header 1", "Header 2") // before the synopsis synopsisHeading("%n@\|bold,underline Usage:\|@ ") descriptionHeading("%n@\|bold,underline Description heading:\|@%n") description("Description 1", "Description 2") // after the synopsis optionListHeading("%n@\|bold,underline Options heading:\|@%n") footerHeading("%n@\|bold,underline Footer heading:\|@%n") footer("Footer 1", "Footer 2") } ``` Supported Option Properties: \| Property \| Type \| Picocli equivalent \| Description \| \| --- \| --- \| --- \| --- \| \| `argName` \| String \| `names` \| Short name for the option, will be prefixed with a single hyphen. \| \| `longOpt` \| String \| `names` \| Long name for the option, will be prefixed with two hyphens unless [acceptLongOptionsWithSingleHyphen](clibuilder#acceptLongOptionsWithSingleHyphen "acceptLongOptionsWithSingleHyphen") is `true`. An option must have either a long name or a short name (or both). \| \| `args` \| int or String \| `arity` \| `args` indicates the number of parameters for this option. A String value of '+' indicates at least one up to any number of parameters. The minimum number of parameters depends on the type (booleans require no parameters) and the `optionalArg` setting. `args` can often be omitted if a `type` is specified. \| \| `optionalArg` \| boolean \| `arity` \| If `optionalArg=true`, then `args=3` is the equivalent of `arity="0..3"` in picocli. When `optionalArg=true`, `args='+'` is equivalent to `arity="0.."`. \| \| `required` \| boolean \| `required` \| If `true`, this option must be specified on the command line, or an exception is thrown. \| \| `type` \| Class \| `type` \| Option parameters are converted to this type. The underlying library has built-in converters for [many types](http://picocli.info/#_built_in_types). A custom converter can be specified with the `convert` property. \| \| `convert` \| Closure \| `converter` \| A closure that takes a single String parameter and returns an object converted to the `type` of this option. The picocli equivalent is the `[ITypeConverter](http://picocli.info/#_custom_type_converters)` interface. \| \| `valueSeparator` \| char \| `splitRegex` \| The character used to split a single command line argument into parts. \| \| `defaultValue` \| String \| `defaultValue` \| The value the option should have if it did not appear on the command line. The specified String value will be split into parts with the `valueSeparator` and converted to the option `type` before it is set. \| See groovy.cli.picocli.CliBuilderTest for further examples. @-files* CliBuilder also supports Argument File processing. If an argument starts with an '@' character followed by a filename, then the contents of the file with name filename are placed into the command line. The feature can be turned off by setting expandArgumentFiles to false. If turned on, you can still pass a real parameter with an initial '@' character by escaping it with an additional '@' symbol, e.g. '@@foo' will become '@foo' and not be subject to expansion. As an example, if the file temp.args contains the content: ``` -arg1 paramA paramB paramC ``` Then calling the command line with: ``` someCommand ``` temp.args: -arg2 paramD Is the same as calling this: ``` someCommand -arg1 paramA paramB paramC -arg2 paramD ``` This feature is particularly useful on operating systems which place limitations on the size of the command line (e.g. Windows). The feature is similar to the 'Command Line Argument File' processing supported by javadoc and javac. Consult the corresponding documentation for those tools if you wish to see further examples. Annotation style with an interface With this style an interface is defined containing an annotated method for each option. It might look like this (following roughly the earlier 'ls' example): ``` import groovy.cli.Option import groovy.cli.Unparsed interface OptionInterface { ``` @[Option](../option "Option")(shortName='a', description='display all files') boolean all() @[Option](../option "Option")(shortName='l', description='use a long listing format') boolean longFormat() @[Option](../option "Option")(shortName='t', description='sort by modification time') boolean time() @[Unparsed](../unparsed "Unparsed") List remaining() } Then this description is supplied to CliBuilder during parsing, e.g.: ``` def args = '-alt .groovy'.split() // normally from commandline itself def cli = new CliBuilder(usage:'ls') def options = cli.parseFromSpec(OptionInterface, args) assert options.remaining() == ['.groovy'] assert options.all() && options.longFormat() && options.time() ``` Annotation style with a class With this style a user-supplied instance is used. Annotations on that instance's class members (properties and setter methods) indicate how to set options and provide the option details using annotation attributes. It might look like this (again using the earlier 'ls' example): ``` import groovy.cli.Option import groovy.cli.Unparsed class OptionClass { @[Option](../option "Option")(shortName='a', description='display all files') boolean all @[Option](../option "Option")(shortName='l', description='use a long listing format') boolean longFormat @[Option](../option "Option")(shortName='t', description='sort by modification time') boolean time @[Unparsed](../unparsed "Unparsed") List remaining } ``` Then this description is supplied to CliBuilder during parsing, e.g.: ``` def args = '-alt .groovy'.split() // normally from commandline itself def cli = new CliBuilder(usage:'ls') def options = new OptionClass() cli.parseFromInstance(options, args) assert options.remaining == ['.groovy'] assert options.all && options.longFormat && options.time ``` Properties Summary ------------------ Properties \| Type \| Name and description \| \| `boolean` \| `[acceptLongOptionsWithSingleHyphen](#acceptLongOptionsWithSingleHyphen)`For backwards compatibility with Apache Commons CLI, set this property to `true` if the parser should recognize long options with both a single hyphen and a double hyphen prefix. \| \| `[PrintWriter](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html "PrintWriter")` \| `[errorWriter](#errorWriter)`The PrintWriter to write to when invalid user input was provided to the [parse(java.lang.String[])](#parse(java.lang.String)) method. \| \| `boolean` \| `[expandArgumentFiles](#expandArgumentFiles)`Whether arguments of the form '`@`filename' will be expanded into the arguments contained within the file named filename (default true). \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[footer](#footer)`Optional additional message for usage; displayed after the options. \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[header](#header)`Optional additional message for usage; displayed after the usage summary but before the options are displayed. \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[name](#name)`This property allows customizing the program name displayed in the synopsis when `cli.usage()` is called. \| \| `[CommandLine.Model.ParserSpec](https://picocli.info/apidocs/picocli/CommandLine.Model.ParserSpec.html "CommandLine.Model.ParserSpec")` \| `[parser](#parser)` \| \| `[Boolean](https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html "Boolean")` \| `[posix](#posix)`To disallow clustered POSIX short options, set this to false. \| \| `[Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), TypedOption>` \| `[savedTypeOptions](#savedTypeOptions)`Internal data structure mapping option names to their associated TypedOption object. \| \| `boolean` \| `[stopAtNonOption](#stopAtNonOption)`Configures what the parser should do when arguments not recognized as options are encountered: when `true` (the default), the remaining arguments are all treated as positional parameters. \| \| `[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[usage](#usage)`The command synopsis displayed as the first line in the usage help message, e.g., when `cli.usage()` is called. \| \| `[CommandLine.Model.UsageMessageSpec](https://picocli.info/apidocs/picocli/CommandLine.Model.UsageMessageSpec.html "CommandLine.Model.UsageMessageSpec")` \| `[usageMessage](#usageMessage)` \| \| `int` \| `[width](#width)`Allows customisation of the usage message width. \| \| `[PrintWriter](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html "PrintWriter")` \| `[writer](#writer)`The PrintWriter to write the [usage](#usage) help message to when `cli.usage()` is called. \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[CliBuilder](#CliBuilder())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[invokeMethod](#invokeMethod(java.lang.String,%20java.lang.Object))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args)`Internal method: Detect option specification method calls. \| \| `<T>` \| `TypedOption<T>` \| `[option](#option(java.util.Map,%20Class,%20java.lang.String))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") args, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<T> type, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") description)` \| \| \| `[CommandLine.Model.OptionSpec](https://picocli.info/apidocs/picocli/CommandLine.Model.OptionSpec.html "CommandLine.Model.OptionSpec")` \| `[option](#option(java.lang.Object,%20java.util.Map,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") shortname, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") details, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") description)`Internal method: How to create an OptionSpec from the specification. \| \| \| `[OptionAccessor](optionaccessor)` \| `[parse](#parse(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args)`Make options accessible from command line args with parser. \| \| `<T>` \| `T` \| `[parseFromInstance](#parseFromInstance(T,%20java.lang.Object))(T optionInstance, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args)`Given an instance containing members with annotations, derive the options specification. \| \| `<T>` \| `T` \| `[parseFromSpec](#parseFromSpec(Class,%20java.lang.String))([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<T> optionsClass, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")[] args)`Given an interface containing members with annotations, derive the options specification. \| \| \| `void` \| `[setExpandArgumentFiles](#setExpandArgumentFiles(boolean))(boolean expand)`Sets the [expandArgumentFiles](#expandArgumentFiles) property on this `CliBuilder` and on the [parser](#parser) used by the underlying library. \| \| \| `void` \| `[setFooter](#setFooter(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") footer)`Sets the [footer](#footer) property on this `CliBuilder` and on the [usageMessage](#usageMessage) used by the underlying library. \| \| \| `void` \| `[setHeader](#setHeader(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") header)`Sets the [header](#header) property on this `CliBuilder` and the `description` on the [usageMessage](#usageMessage) used by the underlying library. \| \| \| `void` \| `[setPosix](#setPosix(java.lang.Boolean))([Boolean](https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html "Boolean") posix)`Sets the [posix](#posix) property on this `CliBuilder` and the `posixClusteredShortOptionsAllowed` property on the [parser](#parser) used by the underlying library. \| \| \| `void` \| `[setStopAtNonOption](#setStopAtNonOption(boolean))(boolean stopAtNonOption)`Sets the [stopAtNonOption](#stopAtNonOption) property on this `CliBuilder` and the `stopAtPositional` property on the [parser](#parser) used by the underlying library. \| \| \| `void` \| `[setUsage](#setUsage(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") usage)`Sets the [usage](#usage) property on this `CliBuilder` and the `customSynopsis` on the [usageMessage](#usageMessage) used by the underlying library. \| \| \| `void` \| `[setWidth](#setWidth(int))(int width)`Sets the [width](#width) property on this `CliBuilder` and on the [usageMessage](#usageMessage) used by the underlying library. \| \| \| `void` \| `[setWriter](#setWriter(java.io.PrintWriter))([PrintWriter](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html "PrintWriter") writer)`For backwards compatibility reasons, if a custom `writer` is set, this sets both the [writer](#writer) and the [errorWriter](#errorWriter) to the specified writer. \| \| \| `void` \| `[usage](#usage())()`Prints the usage message with the specified [header](#header), [footer](#footer) and [width](#width) to the specified [writer](#writer) (default: System.out). \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Property Detail --------------- ### boolean acceptLongOptionsWithSingleHyphen For backwards compatibility with Apache Commons CLI, set this property to `true` if the parser should recognize long options with both a single hyphen and a double hyphen prefix. The default is `false`, so only long options with a double hypen prefix (`--option`) are recognized. Since: 2.5 ### [PrintWriter](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html "PrintWriter") errorWriter The PrintWriter to write to when invalid user input was provided to the [parse(java.lang.String[])](#parse(java.lang.String)) method. Defaults to stderr but you can provide your own PrintWriter if desired. Since: 2.5 ### boolean expandArgumentFiles Whether arguments of the form '`@`filename' will be expanded into the arguments contained within the file named filename (default true). ### [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") footer Optional additional message for usage; displayed after the options. ### [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") header Optional additional message for usage; displayed after the usage summary but before the options are displayed. ### [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name This property allows customizing the program name displayed in the synopsis when `cli.usage()` is called. Ignored if the [usage](#usage) property is set. Since: 2.5 ### final [CommandLine.Model.ParserSpec](https://picocli.info/apidocs/picocli/CommandLine.Model.ParserSpec.html "CommandLine.Model.ParserSpec") parser ### [Boolean](https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html "Boolean") posix To disallow clustered POSIX short options, set this to false. ### [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), TypedOption> savedTypeOptions Internal data structure mapping option names to their associated TypedOption object. ### boolean stopAtNonOption Configures what the parser should do when arguments not recognized as options are encountered: when `true` (the default), the remaining arguments are all treated as positional parameters. When `false`, the parser will continue to look for options, and only the unrecognized arguments are treated as positional parameters. ### [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") usage The command synopsis displayed as the first line in the usage help message, e.g., when `cli.usage()` is called. When not set, a default synopsis is generated that shows the supported options and parameters. See Also: [name](#name) ### final [CommandLine.Model.UsageMessageSpec](https://picocli.info/apidocs/picocli/CommandLine.Model.UsageMessageSpec.html "CommandLine.Model.UsageMessageSpec") usageMessage ### int width Allows customisation of the usage message width. ### [PrintWriter](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html "PrintWriter") writer The PrintWriter to write the [usage](#usage) help message to when `cli.usage()` is called. Defaults to stdout but you can provide your own PrintWriter if desired. Constructor Detail ------------------ ### CliBuilder() Method Detail ------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") invokeMethod([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args) Internal method: Detect option specification method calls. ### <T> TypedOption<T> option([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") args, [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<T> type, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") description) ### [CommandLine.Model.OptionSpec](https://picocli.info/apidocs/picocli/CommandLine.Model.OptionSpec.html "CommandLine.Model.OptionSpec") option([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") shortname, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") details, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") description) Internal method: How to create an OptionSpec from the specification. ### [OptionAccessor](optionaccessor) parse([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args) Make options accessible from command line args with parser. Returns null on bad command lines after displaying usage message. ### <T> T parseFromInstance(T optionInstance, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args) Given an instance containing members with annotations, derive the options specification. Parameters: optionInstance args Returns: the options instance populated with the processed options ### <T> T parseFromSpec([Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html "Class")<T> optionsClass, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")[] args) Given an interface containing members with annotations, derive the options specification. Parameters: optionsClass args Returns: an instance containing the processed options ### void setExpandArgumentFiles(boolean expand) Sets the [expandArgumentFiles](#expandArgumentFiles) property on this `CliBuilder` and on the [parser](#parser) used by the underlying library. @-files Parameters: `expand` - whether to expand argument ### void setFooter([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") footer) Sets the [footer](#footer) property on this `CliBuilder` and on the [usageMessage](#usageMessage) used by the underlying library. Parameters: `footer` - the footer of the usage help message ### void setHeader([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") header) Sets the [header](#header) property on this `CliBuilder` and the `description` on the [usageMessage](#usageMessage) used by the underlying library. Parameters: `header` - the description text of the usage help message ### void setPosix([Boolean](https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html "Boolean") posix) Sets the [posix](#posix) property on this `CliBuilder` and the `posixClusteredShortOptionsAllowed` property on the [parser](#parser) used by the underlying library. Parameters: `posix` - whether to allow clustered short options ### void setStopAtNonOption(boolean stopAtNonOption) Sets the [stopAtNonOption](#stopAtNonOption) property on this `CliBuilder` and the `stopAtPositional` property on the [parser](#parser) used by the underlying library. Parameters: `stopAtNonOption` - when `true` (the default), the remaining arguments are all treated as positional parameters. When `false`, the parser will continue to look for options, and only the unrecognized arguments are treated as positional parameters. ### void setUsage([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") usage) Sets the [usage](#usage) property on this `CliBuilder` and the `customSynopsis` on the [usageMessage](#usageMessage) used by the underlying library. Parameters: `usage` - the custom synopsis of the usage help message ### void setWidth(int width) Sets the [width](#width) property on this `CliBuilder` and on the [usageMessage](#usageMessage) used by the underlying library. Parameters: `width` - the width of the usage help message ### void setWriter([PrintWriter](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html "PrintWriter") writer) For backwards compatibility reasons, if a custom `writer` is set, this sets both the [writer](#writer) and the [errorWriter](#errorWriter) to the specified writer. Parameters: `writer` - the writer to initialize both the `writer` and the `errorWriter` to ### void usage() Prints the usage message with the specified [header](#header), [footer](#footer) and [width](#width) to the specified [writer](#writer) (default: System.out).	programming_docs
groovy [Groovy] Class StreamingMarkupBuilder [Groovy] Class StreamingMarkupBuilder ===================================== * groovy.xml.StreamingMarkupBuilder ``` class StreamingMarkupBuilder extends [AbstractStreamingBuilder](streamingmarkupsupport/abstractstreamingbuilder) ``` A builder class for creating XML markup. This implementation uses a [StreamingMarkupWriter](streamingmarkupsupport/streamingmarkupwriter "StreamingMarkupWriter") to handle output. Example: ``` System.out << new StreamingMarkupBuilder().bind { root { a( a1:'one' ) { b { mkp.yield( '3 < 5' ) } c( a2:'two', 'blah' ) } } } ``` Will output the following String, without newlines or indentation: ``` <root> <a a1='one'> <b>3 < 5</b> <c a2='two'>blah</c> </a> </root> ``` Notes: * that `mkp` is a special namespace used to escape away from the normal building mode of the builder and get access to helper markup methods 'yield', 'pi', 'comment', 'out', 'namespaces', 'xmlDeclaration' and 'yieldUnescaped'. * Note that tab, newline and carriage return characters are escaped within attributes, i.e. will become , and respectively Properties Summary ------------------ Properties \| Type \| Name and description \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[builder](#builder)` \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[commentClosure](#commentClosure)`Invoked by calling `mkp.comment` \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[declarationClosure](#declarationClosure)`Invoked by calling `mkp.xmlDeclaration` \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[encoding](#encoding)` \| \| `boolean` \| `[expandEmptyElements](#expandEmptyElements)` \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[noopClosure](#noopClosure)`Invoked by calling `mkp.yield`. \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[pendingStack](#pendingStack)` \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[piClosure](#piClosure)`Invoked by calling `mkp.pi` \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[tagClosure](#tagClosure)` \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[unescapedClosure](#unescapedClosure)`Invoked by calling `mkp.yieldUnescaped`. \| \| `boolean` \| `[useDoubleQuotes](#useDoubleQuotes)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[StreamingMarkupBuilder](#StreamingMarkupBuilder())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[bind](#bind(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") closure)`Returns a [Writable](../lang/writable "Writable") object, which may be used to render the markup directly to a String, or send the output to a stream. \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[bindNode](#bindNode(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node)`Convenience method for binding a single node. \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getQt](#getQt())()` \| Property Detail --------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") builder ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") commentClosure Invoked by calling `mkp.comment` ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") declarationClosure Invoked by calling `mkp.xmlDeclaration` ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") encoding ### boolean expandEmptyElements ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") noopClosure Invoked by calling `mkp.yield`. Used to render text to the output stream. Any XML reserved characters will be escaped to ensure well-formedness. ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") pendingStack ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") piClosure Invoked by calling `mkp.pi` ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") tagClosure ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") unescapedClosure Invoked by calling `mkp.yieldUnescaped`. Used to render literal text or markup to the output stream. No escaping is done on the output. ### boolean useDoubleQuotes Constructor Detail ------------------ ### StreamingMarkupBuilder() Method Detail ------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") bind([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") closure) Returns a [Writable](../lang/writable "Writable") object, which may be used to render the markup directly to a String, or send the output to a stream. Examples: ``` // get the markup as a string: new StreamingMarkupBuilder().bind { div { out << "hello world" } }.toString() // send the output directly to a file: new StreamingMarkupBuilder().bind { div { out << "hello world" } } \ .writeTo( new File('myFile.xml').newWriter() ) ``` Returns: a [Writable](../lang/writable "Writable") to render the markup ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") bindNode([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node) Convenience method for binding a single node. The call `bindNode(node)` is equivalent to `bind{ out << node }`. Returns a [Writable](../lang/writable "Writable") object, which may be used to render the markup directly to a String, or send the output to a stream. See Also: [bind(Closure)](#bind(groovy.lang.Closure)) Returns: a [Writable](../lang/writable "Writable") to render the markup ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getQt() groovy [Groovy] Class StreamingDOMBuilder [Groovy] Class StreamingDOMBuilder ================================== * groovy.xml.StreamingDOMBuilder ``` class StreamingDOMBuilder extends [AbstractStreamingBuilder](streamingmarkupsupport/abstractstreamingbuilder) ``` Properties Summary ------------------ Properties \| Type \| Name and description \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[builder](#builder)` \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[commentClosure](#commentClosure)` \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[defaultNamespaceStack](#defaultNamespaceStack)` \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[noopClosure](#noopClosure)` \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[pendingStack](#pendingStack)` \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[piClosure](#piClosure)` \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[tagClosure](#tagClosure)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[StreamingDOMBuilder](#StreamingDOMBuilder())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[bind](#bind(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") closure)` \| Property Detail --------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") builder ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") commentClosure ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") defaultNamespaceStack ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") noopClosure ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") pendingStack ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") piClosure ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") tagClosure Constructor Detail ------------------ ### StreamingDOMBuilder() Method Detail ------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") bind([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") closure) groovy [Groovy] Class StaxBuilder [Groovy] Class StaxBuilder ========================== * groovy.xml.StaxBuilder ``` class StaxBuilder extends [BuilderSupport](../util/buildersupport) ``` A Groovy builder that works with Stax processors. A typical usage is as follows: ``` import javax.xml.stream.XMLOutputFactory def factory = XMLOutputFactory.newInstance() def writer = new StringWriter() def builder = new groovy.xml.StaxBuilder(factory.createXMLStreamWriter(writer)) builder.root1(a:5, b:7) { elem1('hello1') elem2('hello2') elem3(x:7) } assert writer.toString() == 'xml version="1.0" ?hello1hello2' ``` Or an external library such as Jettison can be used as follows: ``` @Grab('org.codehaus.jettison:jettison:1.2') import org.codehaus.jettison.mapped.* import javax.xml.stream.XMLStreamException def conv = new MappedNamespaceConvention() def writer = new StringWriter() def mappedWriter = new MappedXMLStreamWriter(conv, writer) def builder = new groovy.xml.StaxBuilder(mappedWriter) builder.root1(a:5, b:7) { elem1('hello1') elem2('hello2') elem3(x:7) } assert writer.toString() == '''{"root1":{"@a":"5","@b":"7","elem1":"hello1","elem2":"hello2","elem3":{"@x":"7"}}}''' ``` Properties Summary ------------------ Properties \| Type \| Name and description \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[writer](#writer)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[StaxBuilder](#StaxBuilder(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") xmlStreamWriter)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[createNode](#createNode(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name)` \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[createNode](#createNode(java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[createNode](#createNode(java.lang.Object,%20java.util.Map))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[createNode](#createNode(java.lang.Object,%20java.util.Map,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| \| \| `protected void` \| `[nodeCompleted](#nodeCompleted(java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node)` \| \| \| `protected void` \| `[setParent](#setParent(java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [BuilderSupport](../util/buildersupport)` \| `[createNode](../util/buildersupport#createNode(java.lang.Object)), [createNode](../util/buildersupport#createNode(java.lang.Object,%20java.lang.Object)), [createNode](../util/buildersupport#createNode(java.lang.Object,%20java.util.Map)), [createNode](../util/buildersupport#createNode(java.lang.Object,%20java.util.Map,%20java.lang.Object)), [doInvokeMethod](../util/buildersupport#doInvokeMethod(java.lang.String,%20java.lang.Object,%20java.lang.Object)), [getCurrent](../util/buildersupport#getCurrent()), [getName](../util/buildersupport#getName(java.lang.String)), [invokeMethod](../util/buildersupport#invokeMethod(java.lang.String)), [invokeMethod](../util/buildersupport#invokeMethod(java.lang.String,%20java.lang.Object)), [nodeCompleted](../util/buildersupport#nodeCompleted(java.lang.Object,%20java.lang.Object)), [postNodeCompletion](../util/buildersupport#postNodeCompletion(java.lang.Object,%20java.lang.Object)), [setClosureDelegate](../util/buildersupport#setClosureDelegate(groovy.lang.Closure,%20java.lang.Object)), [setCurrent](../util/buildersupport#setCurrent(java.lang.Object)), [setParent](../util/buildersupport#setParent(java.lang.Object,%20java.lang.Object))` \| \| `class [GroovyObjectSupport](../lang/groovyobjectsupport)` \| `[getMetaClass](../lang/groovyobjectsupport#getMetaClass()), [setMetaClass](../lang/groovyobjectsupport#setMetaClass(groovy.lang.MetaClass))` \| Property Detail --------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") writer Constructor Detail ------------------ ### StaxBuilder([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") xmlStreamWriter) Method Detail ------------- ### protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") createNode([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name) ### protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") createNode([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) ### protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") createNode([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) ### protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") createNode([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) ### protected void nodeCompleted([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node) ### protected void setParent([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child) groovy [Groovy] Class StreamingSAXBuilder [Groovy] Class StreamingSAXBuilder ================================== * groovy.xml.StreamingSAXBuilder ``` class StreamingSAXBuilder extends [AbstractStreamingBuilder](streamingmarkupsupport/abstractstreamingbuilder) ``` Properties Summary ------------------ Properties \| Type \| Name and description \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[builder](#builder)` \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[commentClosure](#commentClosure)` \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[noopClosure](#noopClosure)` \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[pendingStack](#pendingStack)` \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[piClosure](#piClosure)` \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[tagClosure](#tagClosure)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[StreamingSAXBuilder](#StreamingSAXBuilder())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[bind](#bind(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") closure)` \| Property Detail --------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") builder ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") commentClosure ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") noopClosure ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") pendingStack ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") piClosure ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") tagClosure Constructor Detail ------------------ ### StreamingSAXBuilder() Method Detail ------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") bind([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") closure) groovy [Groovy] Class XmlParserFactory [Groovy] Class XmlParserFactory =============================== * groovy.xml.XmlParserFactory ``` class XmlParserFactory extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Factory method targetting dynamic contexts which allows a new `XmlParser` to be created. It is intended to assist with migration from Groovy 2.5.x to Groovy 3+. Code using this factory will not need to change moving from 2.x to 3+. In Groovy 2.5.x, a `groovy.util.XmlParser` will be returned. For Groovy 3+, a `groovy.xml.XmlParser` will be returned. For contexts requiring additional static type checking, it is recommended simply to use the normal constructor and change the package to `groovy.xml` prior to reaching Groovy 4. Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[XmlParserFactory](#XmlParserFactory())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newParser](#newParser(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] args)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### XmlParserFactory() Method Detail ------------- ### static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newParser([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] args)	programming_docs
groovy [Java] Class NamespaceBuilder [Java] Class NamespaceBuilder ============================= * groovy.xml.NamespaceBuilder ``` public class NamespaceBuilder extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` A helper class for creating namespaces for GroovyMarkup Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[NamespaceBuilder](#NamespaceBuilder(groovy.util.BuilderSupport))([BuilderSupport](../util/buildersupport) builder)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [NamespaceBuilderSupport](namespacebuildersupport)` \| `[declareNamespace](#declareNamespace(java.util.Map))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") ns)` \| \| \| `public [NamespaceBuilderSupport](namespacebuildersupport)` \| `[namespace](#namespace(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri)` \| \| \| `public [NamespaceBuilderSupport](namespacebuildersupport)` \| `[namespace](#namespace(java.lang.String,%20java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") prefix)` \| \| \| `public static [NamespaceBuilderSupport](namespacebuildersupport)` \| `[newInstance](#newInstance(groovy.util.BuilderSupport,%20java.lang.String))([BuilderSupport](../util/buildersupport) builder, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri)` \| \| \| `public static [NamespaceBuilderSupport](namespacebuildersupport)` \| `[newInstance](#newInstance(groovy.util.BuilderSupport))([BuilderSupport](../util/buildersupport) builder)` \| \| \| `public static [NamespaceBuilderSupport](namespacebuildersupport)` \| `[newInstance](#newInstance(groovy.util.BuilderSupport,%20java.lang.String,%20java.lang.String))([BuilderSupport](../util/buildersupport) builder, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") prefix)` \| \| \| `public static [NamespaceBuilderSupport](namespacebuildersupport)` \| `[newInstance](#newInstance(java.util.Map,%20groovy.util.BuilderSupport))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") nsMap, [BuilderSupport](../util/buildersupport) builder)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public NamespaceBuilder([BuilderSupport](../util/buildersupport) builder) Method Detail ------------- ### public [NamespaceBuilderSupport](namespacebuildersupport) declareNamespace([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") ns) ### public [NamespaceBuilderSupport](namespacebuildersupport) namespace([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri) ### public [NamespaceBuilderSupport](namespacebuildersupport) namespace([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") prefix) ### public static [NamespaceBuilderSupport](namespacebuildersupport) newInstance([BuilderSupport](../util/buildersupport) builder, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri) ### public static [NamespaceBuilderSupport](namespacebuildersupport) newInstance([BuilderSupport](../util/buildersupport) builder) ### public static [NamespaceBuilderSupport](namespacebuildersupport) newInstance([BuilderSupport](../util/buildersupport) builder, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") prefix) ### public static [NamespaceBuilderSupport](namespacebuildersupport) newInstance([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") nsMap, [BuilderSupport](../util/buildersupport) builder) groovy [Java] Class FactorySupport [Java] Class FactorySupport =========================== * groovy.xml.FactorySupport ``` public class FactorySupport extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Support class for creating XML Factories Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public static [DocumentBuilderFactory](https://docs.oracle.com/javase/8/docs/api/javax/xml/parsers/DocumentBuilderFactory.html "DocumentBuilderFactory")` \| `[createDocumentBuilderFactory](#createDocumentBuilderFactory())()` \| \| \| `public static [SAXParserFactory](https://docs.oracle.com/javase/8/docs/api/javax/xml/parsers/SAXParserFactory.html "SAXParserFactory")` \| `[createSaxParserFactory](#createSaxParserFactory())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### public static [DocumentBuilderFactory](https://docs.oracle.com/javase/8/docs/api/javax/xml/parsers/DocumentBuilderFactory.html "DocumentBuilderFactory") createDocumentBuilderFactory() ### public static [SAXParserFactory](https://docs.oracle.com/javase/8/docs/api/javax/xml/parsers/SAXParserFactory.html "SAXParserFactory") createSaxParserFactory() groovy [Java] Class XmlNodePrinter.NamespaceContext [Java] Class XmlNodePrinter.NamespaceContext ============================================ * groovy.xml.XmlNodePrinter.NamespaceContext ``` protected static class XmlNodePrinter.NamespaceContext ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[NamespaceContext](#NamespaceContext())()` \| \| `[NamespaceContext](#NamespaceContext(NamespaceContext))([NamespaceContext](../../namespacecontext) context)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getNamespace](#getNamespace(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") prefix)` \| \| \| `public boolean` \| `[isPrefixRegistered](#isPrefixRegistered(java.lang.String,%20java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") prefix, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri)` \| \| \| `public void` \| `[registerNamespacePrefix](#registerNamespacePrefix(java.lang.String,%20java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") prefix, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public NamespaceContext() ### public NamespaceContext([NamespaceContext](../../namespacecontext) context) Method Detail ------------- ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getNamespace([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") prefix) ### public boolean isPrefixRegistered([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") prefix, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri) ### public void registerNamespacePrefix([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") prefix, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri) groovy [Java] Class Namespace [Java] Class Namespace ====================== * groovy.xml.Namespace ``` public class Namespace extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` A simple helper class which acts as a factory of [QName](../namespace/qname "QName") instances. Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[Namespace](#Namespace())()` \| \| `[Namespace](#Namespace(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri)` \| \| `[Namespace](#Namespace(java.lang.String,%20java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") prefix)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [QName](../namespace/qname)` \| `[get](#get(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") localName)`Returns the QName for the given localName. \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getPrefix](#getPrefix())()`Returns the prefix mapped to this namespace \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getUri](#getUri())()`Returns the URI of this namespace \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public Namespace() ### public Namespace([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri) ### public Namespace([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") prefix) Method Detail ------------- ### public [QName](../namespace/qname) get([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") localName) Returns the QName for the given localName. Parameters: `localName` - the local name within this ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getPrefix() Returns the prefix mapped to this namespace Returns: the prefix assigned to this namespace or null if no namespace is mapped. ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getUri() Returns the URI of this namespace Returns: the URI of this namespace groovy [Java] Class XmlUtil [Java] Class XmlUtil ==================== * groovy.xml.XmlUtil ``` public class XmlUtil extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Used for pretty printing XML content and other XML related utilities. Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[doCall](#doCall(java.lang.Character))([Character](https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html "Character") arg)` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[doCall](#doCall(java.lang.Character))([Character](https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html "Character") arg)` \| \| \| `public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[escapeControlCharacters](#escapeControlCharacters(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") orig)`Escape control characters (below 0x20) with their XML entities, e.g. \| \| \| `public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[escapeXml](#escapeXml(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") orig)`Escape the following characters `" ' & < >` with their XML entities, e.g. \| \| \| `public static [SAXParser](https://docs.oracle.com/javase/8/docs/api/javax/xml/parsers/SAXParser.html "SAXParser")` \| `[newSAXParser](#newSAXParser(java.lang.String,%20javax.xml.transform.Source))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") schemaLanguage, [Source](https://docs.oracle.com/javase/8/docs/api/javax/xml/transform/Source.html "Source") schemas)`Factory method to create a SAXParser configured to validate according to a particular schema language and optionally providing the schema sources to validate with. \| \| \| `public static [SAXParser](https://docs.oracle.com/javase/8/docs/api/javax/xml/parsers/SAXParser.html "SAXParser")` \| `[newSAXParser](#newSAXParser(java.lang.String,%20boolean,%20boolean,%20javax.xml.transform.Source))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") schemaLanguage, boolean namespaceAware, boolean validating, [Source](https://docs.oracle.com/javase/8/docs/api/javax/xml/transform/Source.html "Source") schemas)`Factory method to create a SAXParser configured to validate according to a particular schema language and optionally providing the schema sources to validate with. \| \| \| `public static [SAXParser](https://docs.oracle.com/javase/8/docs/api/javax/xml/parsers/SAXParser.html "SAXParser")` \| `[newSAXParser](#newSAXParser(java.lang.String,%20java.io.File))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") schemaLanguage, [File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File") schema)`Factory method to create a SAXParser configured to validate according to a particular schema language and a File containing the schema to validate against. \| \| \| `public static [SAXParser](https://docs.oracle.com/javase/8/docs/api/javax/xml/parsers/SAXParser.html "SAXParser")` \| `[newSAXParser](#newSAXParser(java.lang.String,%20boolean,%20boolean,%20java.io.File))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") schemaLanguage, boolean namespaceAware, boolean validating, [File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File") schema)`Factory method to create a SAXParser configured to validate according to a particular schema language and a File containing the schema to validate against. \| \| \| `public static [SAXParser](https://docs.oracle.com/javase/8/docs/api/javax/xml/parsers/SAXParser.html "SAXParser")` \| `[newSAXParser](#newSAXParser(java.lang.String,%20java.net.URL))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") schemaLanguage, [URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html "URL") schema)`Factory method to create a SAXParser configured to validate according to a particular schema language and an URL pointing to the schema to validate against. \| \| \| `public static [SAXParser](https://docs.oracle.com/javase/8/docs/api/javax/xml/parsers/SAXParser.html "SAXParser")` \| `[newSAXParser](#newSAXParser(java.lang.String,%20boolean,%20boolean,%20java.net.URL))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") schemaLanguage, boolean namespaceAware, boolean validating, [URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html "URL") schema)`Factory method to create a SAXParser configured to validate according to a particular schema language and an URL pointing to the schema to validate against. \| \| \| `public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[serialize](#serialize(javax.swing.text.Element))([Element](https://docs.oracle.com/javase/8/docs/api/javax/swing/text/Element.html "Element") element)`Return a pretty String version of the Element. \| \| \| `public static void` \| `[serialize](#serialize(javax.swing.text.Element,%20java.io.OutputStream))([Element](https://docs.oracle.com/javase/8/docs/api/javax/swing/text/Element.html "Element") element, [OutputStream](https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html "OutputStream") os)`Write a pretty version of the Element to the OutputStream. \| \| \| `public static void` \| `[serialize](#serialize(javax.swing.text.Element,%20java.io.Writer))([Element](https://docs.oracle.com/javase/8/docs/api/javax/swing/text/Element.html "Element") element, [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") w)`Write a pretty version of the Element to the Writer. \| \| \| `public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[serialize](#serialize(groovy.util.Node))([Node](../util/node) node)`Return a pretty String version of the Node. \| \| \| `public static void` \| `[serialize](#serialize(groovy.util.Node,%20java.io.OutputStream))([Node](../util/node) node, [OutputStream](https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html "OutputStream") os)`Write a pretty version of the Node to the OutputStream. \| \| \| `public static void` \| `[serialize](#serialize(groovy.util.Node,%20java.io.Writer))([Node](../util/node) node, [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") w)`Write a pretty version of the Node to the Writer. \| \| \| `public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[serialize](#serialize(groovy.xml.slurpersupport.GPathResult))([GPathResult](slurpersupport/gpathresult) node)`Return a pretty version of the GPathResult. \| \| \| `public static void` \| `[serialize](#serialize(groovy.xml.slurpersupport.GPathResult,%20java.io.OutputStream))([GPathResult](slurpersupport/gpathresult) node, [OutputStream](https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html "OutputStream") os)`Write a pretty version of the GPathResult to the OutputStream. \| \| \| `public static void` \| `[serialize](#serialize(groovy.xml.slurpersupport.GPathResult,%20java.io.Writer))([GPathResult](slurpersupport/gpathresult) node, [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") w)`Write a pretty version of the GPathResult to the Writer. \| \| \| `public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[serialize](#serialize(groovy.lang.Writable))([Writable](../lang/writable) writable)`Return a pretty String version of the XML content produced by the Writable. \| \| \| `public static void` \| `[serialize](#serialize(groovy.lang.Writable,%20java.io.OutputStream))([Writable](../lang/writable) writable, [OutputStream](https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html "OutputStream") os)`Write a pretty version of the XML content produced by the Writable to the OutputStream. \| \| \| `public static void` \| `[serialize](#serialize(groovy.lang.Writable,%20java.io.Writer))([Writable](../lang/writable) writable, [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") w)`Write a pretty version of the XML content produced by the Writable to the Writer. \| \| \| `public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[serialize](#serialize(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") xmlString)`Return a pretty version of the XML content contained in the given String. \| \| \| `public static void` \| `[serialize](#serialize(java.lang.String,%20java.io.OutputStream))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") xmlString, [OutputStream](https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html "OutputStream") os)`Write a pretty version of the given XML string to the OutputStream. \| \| \| `public static void` \| `[serialize](#serialize(java.lang.String,%20java.io.Writer))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") xmlString, [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") w)`Write a pretty version of the given XML string to the Writer. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") doCall([Character](https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html "Character") arg) ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") doCall([Character](https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html "Character") arg) ### public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") escapeControlCharacters([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") orig) Escape control characters (below 0x20) with their XML entities, e.g. carriage return (`Ctrl-M or \r`) becomes Notes: * Does not escape non-ascii characters above 0x7e * Does not treat surrogate pairs specially * Does not perform Unicode validation on its input Parameters: `orig` - the original String Returns: A new string in which all characters that require escaping have been replaced with the corresponding XML entities. See Also: [escapeXml(String)](#escapeXml(java.lang.String)) ### public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") escapeXml([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") orig) Escape the following characters `" ' & < >` with their XML entities, e.g. `"bread" & "butter"` becomes `"bread" & "butter&quot`. Notes: * Supports only the five basic XML entities (gt, lt, quot, amp, apos) * Does not escape control characters * Does not support DTDs or external entities * Does not treat surrogate pairs specially * Does not perform Unicode validation on its input Parameters: `orig` - the original String Returns: A new string in which all characters that require escaping have been replaced with the corresponding XML entities. See Also: [escapeControlCharacters(String)](#escapeControlCharacters(java.lang.String)) ### public static [SAXParser](https://docs.oracle.com/javase/8/docs/api/javax/xml/parsers/SAXParser.html "SAXParser") newSAXParser([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") schemaLanguage, [Source](https://docs.oracle.com/javase/8/docs/api/javax/xml/transform/Source.html "Source") schemas) Factory method to create a SAXParser configured to validate according to a particular schema language and optionally providing the schema sources to validate with. The created SAXParser will be namespace-aware and not validate against DTDs. throws: SAXException throws: ParserConfigurationException Parameters: `schemaLanguage` - the schema language used, e.g. XML Schema or RelaxNG (as per the String representation in javax.xml.XMLConstants) `schemas` - the schemas to validate against Returns: the created SAXParser See Also: [newSAXParser(String, boolean, boolean, Source...)](#newSAXParser(java.lang.String,%20boolean,%20boolean,%20Source...)) Since: 1.8.7 ### public static [SAXParser](https://docs.oracle.com/javase/8/docs/api/javax/xml/parsers/SAXParser.html "SAXParser") newSAXParser([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") schemaLanguage, boolean namespaceAware, boolean validating, [Source](https://docs.oracle.com/javase/8/docs/api/javax/xml/transform/Source.html "Source") schemas) Factory method to create a SAXParser configured to validate according to a particular schema language and optionally providing the schema sources to validate with. throws: SAXException throws: ParserConfigurationException Parameters: `schemaLanguage` - the schema language used, e.g. XML Schema or RelaxNG (as per the String representation in javax.xml.XMLConstants) `namespaceAware` - will the parser be namespace aware `validating` - will the parser also validate against DTDs `schemas` - the schemas to validate against Returns: the created SAXParser Since: 1.8.7 ### public static [SAXParser](https://docs.oracle.com/javase/8/docs/api/javax/xml/parsers/SAXParser.html "SAXParser") newSAXParser([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") schemaLanguage, [File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File") schema) Factory method to create a SAXParser configured to validate according to a particular schema language and a File containing the schema to validate against. The created SAXParser will be namespace-aware and not validate against DTDs. throws: SAXException throws: ParserConfigurationException Parameters: `schemaLanguage` - the schema language used, e.g. XML Schema or RelaxNG (as per the String representation in javax.xml.XMLConstants) `schema` - a file containing the schema to validate against Returns: the created SAXParser See Also: [newSAXParser(String, boolean, boolean, File)](#newSAXParser(java.lang.String,%20boolean,%20boolean,%20java.io.File)) Since: 1.8.7 ### public static [SAXParser](https://docs.oracle.com/javase/8/docs/api/javax/xml/parsers/SAXParser.html "SAXParser") newSAXParser([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") schemaLanguage, boolean namespaceAware, boolean validating, [File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File") schema) Factory method to create a SAXParser configured to validate according to a particular schema language and a File containing the schema to validate against. throws: SAXException throws: ParserConfigurationException Parameters: `schemaLanguage` - the schema language used, e.g. XML Schema or RelaxNG (as per the String representation in javax.xml.XMLConstants) `namespaceAware` - will the parser be namespace aware `validating` - will the parser also validate against DTDs `schema` - a file containing the schema to validate against Returns: the created SAXParser Since: 1.8.7 ### public static [SAXParser](https://docs.oracle.com/javase/8/docs/api/javax/xml/parsers/SAXParser.html "SAXParser") newSAXParser([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") schemaLanguage, [URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html "URL") schema) Factory method to create a SAXParser configured to validate according to a particular schema language and an URL pointing to the schema to validate against. The created SAXParser will be namespace-aware and not validate against DTDs. throws: SAXException throws: ParserConfigurationException Parameters: `schemaLanguage` - the schema language used, e.g. XML Schema or RelaxNG (as per the String representation in javax.xml.XMLConstants) `schema` - a URL pointing to the schema to validate against Returns: the created SAXParser See Also: [newSAXParser(String, boolean, boolean, URL)](#newSAXParser(java.lang.String,%20boolean,%20boolean,%20java.net.URL)) Since: 1.8.7 ### public static [SAXParser](https://docs.oracle.com/javase/8/docs/api/javax/xml/parsers/SAXParser.html "SAXParser") newSAXParser([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") schemaLanguage, boolean namespaceAware, boolean validating, [URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html "URL") schema) Factory method to create a SAXParser configured to validate according to a particular schema language and an URL pointing to the schema to validate against. throws: SAXException throws: ParserConfigurationException Parameters: `schemaLanguage` - the schema language used, e.g. XML Schema or RelaxNG (as per the String representation in javax.xml.XMLConstants) `namespaceAware` - will the parser be namespace aware `validating` - will the parser also validate against DTDs `schema` - a URL pointing to the schema to validate against Returns: the created SAXParser Since: 1.8.7 ### public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") serialize([Element](https://docs.oracle.com/javase/8/docs/api/javax/swing/text/Element.html "Element") element) Return a pretty String version of the Element. Parameters: `element` - the Element to serialize Returns: the pretty String representation of the Element ### public static void serialize([Element](https://docs.oracle.com/javase/8/docs/api/javax/swing/text/Element.html "Element") element, [OutputStream](https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html "OutputStream") os) Write a pretty version of the Element to the OutputStream. Parameters: `element` - the Element to serialize `os` - the OutputStream to write to ### public static void serialize([Element](https://docs.oracle.com/javase/8/docs/api/javax/swing/text/Element.html "Element") element, [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") w) Write a pretty version of the Element to the Writer. Parameters: `element` - the Element to serialize `w` - the Writer to write to ### public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") serialize([Node](../util/node) node) Return a pretty String version of the Node. Parameters: `node` - the Node to serialize Returns: the pretty String representation of the Node ### public static void serialize([Node](../util/node) node, [OutputStream](https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html "OutputStream") os) Write a pretty version of the Node to the OutputStream. Parameters: `node` - the Node to serialize `os` - the OutputStream to write to ### public static void serialize([Node](../util/node) node, [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") w) Write a pretty version of the Node to the Writer. Parameters: `node` - the Node to serialize `w` - the Writer to write to ### public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") serialize([GPathResult](slurpersupport/gpathresult) node) Return a pretty version of the GPathResult. Parameters: `node` - a GPathResult to serialize to a String Returns: the pretty String representation of the GPathResult ### public static void serialize([GPathResult](slurpersupport/gpathresult) node, [OutputStream](https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html "OutputStream") os) Write a pretty version of the GPathResult to the OutputStream. Parameters: `node` - a GPathResult to serialize `os` - the OutputStream to write to ### public static void serialize([GPathResult](slurpersupport/gpathresult) node, [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") w) Write a pretty version of the GPathResult to the Writer. Parameters: `node` - a GPathResult to serialize `w` - the Writer to write to ### public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") serialize([Writable](../lang/writable) writable) Return a pretty String version of the XML content produced by the Writable. Parameters: `writable` - the Writable to serialize Returns: the pretty String representation of the content from the Writable ### public static void serialize([Writable](../lang/writable) writable, [OutputStream](https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html "OutputStream") os) Write a pretty version of the XML content produced by the Writable to the OutputStream. Parameters: `writable` - the Writable to serialize `os` - the OutputStream to write to ### public static void serialize([Writable](../lang/writable) writable, [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") w) Write a pretty version of the XML content produced by the Writable to the Writer. Parameters: `writable` - the Writable to serialize `w` - the Writer to write to ### public static [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") serialize([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") xmlString) Return a pretty version of the XML content contained in the given String. Parameters: `xmlString` - the String to serialize Returns: the pretty String representation of the original content ### public static void serialize([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") xmlString, [OutputStream](https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html "OutputStream") os) Write a pretty version of the given XML string to the OutputStream. Parameters: `xmlString` - the String to serialize `os` - the OutputStream to write to ### public static void serialize([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") xmlString, [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") w) Write a pretty version of the given XML string to the Writer. Parameters: `xmlString` - the String to serialize `w` - the Writer to write to	programming_docs
groovy [Java] Class XmlNodePrinter [Java] Class XmlNodePrinter =========================== * groovy.xml.XmlNodePrinter ``` public class XmlNodePrinter extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Prints a `groovy.util.Node` (as used with `XmlParser`) including all children in XML format. Typical usage: ``` def xml = '<html><head><title>Title</title></head><body><h1>Header</h1></body></html>' def root = new XmlParser().parseText(xml) new XmlNodePrinter(preserveWhitespace:true).print(root.body[0]) ``` which when run produces this on stdout (or use your own `PrintWriter` to direct elsewhere): ``` <body> <h1>Header</h1> </body> ``` See Also: [NodePrinter](../util/nodeprinter "NodePrinter") [XmlUtil.serialize](xmlutil#serialize(Node) "XmlUtil.serialize") Nested Class Summary -------------------- Nested classes \| Modifiers \| Name \| Description \| \| `protected static class` \| `[XmlNodePrinter.NamespaceContext](xmlnodeprinter.namespacecontext)` \| \| Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `protected [IndentPrinter](../util/indentprinter)` \| `[out](#out)` \| \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[XmlNodePrinter](#XmlNodePrinter(java.io.PrintWriter))([PrintWriter](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html "PrintWriter") out)` \| \| `[XmlNodePrinter](#XmlNodePrinter(java.io.PrintWriter,%20java.lang.String))([PrintWriter](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html "PrintWriter") out, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") indent)` \| \| `[XmlNodePrinter](#XmlNodePrinter(java.io.PrintWriter,%20java.lang.String,%20java.lang.String))([PrintWriter](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html "PrintWriter") out, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") indent, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") quote)` \| \| `[XmlNodePrinter](#XmlNodePrinter(groovy.util.IndentPrinter))([IndentPrinter](../util/indentprinter) out)` \| \| `[XmlNodePrinter](#XmlNodePrinter(groovy.util.IndentPrinter,%20java.lang.String))([IndentPrinter](../util/indentprinter) out, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") quote)` \| \| `[XmlNodePrinter](#XmlNodePrinter())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getQuote](#getQuote())()`Get Quote to use when printing attributes. \| \| \| `public boolean` \| `[isExpandEmptyElements](#isExpandEmptyElements())()`Whether empty elements are expanded from <tagName/> to <tagName></tagName>. \| \| \| `public boolean` \| `[isNamespaceAware](#isNamespaceAware())()`Check if namespace handling is enabled. \| \| \| `public boolean` \| `[isPreserveWhitespace](#isPreserveWhitespace())()`Check if whitespace preservation is enabled. \| \| \| `public void` \| `[print](#print(groovy.util.Node))([Node](../util/node) node)` \| \| \| `protected void` \| `[print](#print(groovy.util.Node,%20NamespaceContext))([Node](../util/node) node, [NamespaceContext](../../namespacecontext) ctx)` \| \| \| `protected void` \| `[printLineBegin](#printLineBegin())()` \| \| \| `protected void` \| `[printLineEnd](#printLineEnd())()` \| \| \| `protected void` \| `[printLineEnd](#printLineEnd(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") comment)` \| \| \| `protected void` \| `[printList](#printList(java.util.List,%20NamespaceContext))([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") list, [NamespaceContext](../../namespacecontext) ctx)` \| \| \| `protected void` \| `[printName](#printName(groovy.util.Node,%20NamespaceContext,%20boolean,%20boolean))([Node](../util/node) node, [NamespaceContext](../../namespacecontext) ctx, boolean begin, boolean preserve)` \| \| \| `protected void` \| `[printNameAttributes](#printNameAttributes(java.util.Map,%20NamespaceContext))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes, [NamespaceContext](../../namespacecontext) ctx)` \| \| \| `protected void` \| `[printNamespace](#printNamespace(java.lang.Object,%20NamespaceContext))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [NamespaceContext](../../namespacecontext) ctx)` \| \| \| `protected void` \| `[printSimpleItem](#printSimpleItem(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| \| \| `protected boolean` \| `[printSpecialNode](#printSpecialNode(groovy.util.Node))([Node](../util/node) node)` \| \| \| `public void` \| `[setExpandEmptyElements](#setExpandEmptyElements(boolean))(boolean expandEmptyElements)`Whether empty elements are expanded from <tagName/> to <tagName></tagName>. \| \| \| `public void` \| `[setNamespaceAware](#setNamespaceAware(boolean))(boolean namespaceAware)`Enable and/or disable namespace handling. \| \| \| `public void` \| `[setPreserveWhitespace](#setPreserveWhitespace(boolean))(boolean preserveWhitespace)`Enable and/or disable preservation of whitespace. \| \| \| `public void` \| `[setQuote](#setQuote(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") quote)`Set Quote to use when printing attributes. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Field Detail ------------ ### protected final [IndentPrinter](../util/indentprinter) out Constructor Detail ------------------ ### public XmlNodePrinter([PrintWriter](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html "PrintWriter") out) ### public XmlNodePrinter([PrintWriter](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html "PrintWriter") out, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") indent) ### public XmlNodePrinter([PrintWriter](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html "PrintWriter") out, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") indent, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") quote) ### public XmlNodePrinter([IndentPrinter](../util/indentprinter) out) ### public XmlNodePrinter([IndentPrinter](../util/indentprinter) out, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") quote) ### public XmlNodePrinter() Method Detail ------------- ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getQuote() Get Quote to use when printing attributes. Returns: the quote character ### public boolean isExpandEmptyElements() Whether empty elements are expanded from <tagName/> to <tagName></tagName>. Returns: `true`, if empty elements will be represented by an opening tag followed immediately by a closing tag. ### public boolean isNamespaceAware() Check if namespace handling is enabled. Defaults to `true`. Returns: true if namespace handling is enabled ### public boolean isPreserveWhitespace() Check if whitespace preservation is enabled. Defaults to `false`. Returns: true if whitespaces are honoured when printing simple text nodes ### public void print([Node](../util/node) node) ### protected void print([Node](../util/node) node, [NamespaceContext](../../namespacecontext) ctx) ### protected void printLineBegin() ### protected void printLineEnd() ### protected void printLineEnd([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") comment) ### protected void printList([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") list, [NamespaceContext](../../namespacecontext) ctx) ### protected void printName([Node](../util/node) node, [NamespaceContext](../../namespacecontext) ctx, boolean begin, boolean preserve) ### protected void printNameAttributes([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes, [NamespaceContext](../../namespacecontext) ctx) ### protected void printNamespace([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") object, [NamespaceContext](../../namespacecontext) ctx) ### protected void printSimpleItem([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) ### protected boolean printSpecialNode([Node](../util/node) node) ### public void setExpandEmptyElements(boolean expandEmptyElements) Whether empty elements are expanded from <tagName/> to <tagName></tagName>. Parameters: `expandEmptyElements` - if `true`, empty elements will be represented by an opening tag followed immediately by a closing tag. Defaults to `false`. ### public void setNamespaceAware(boolean namespaceAware) Enable and/or disable namespace handling. Parameters: `namespaceAware` - the new desired value ### public void setPreserveWhitespace(boolean preserveWhitespace) Enable and/or disable preservation of whitespace. Parameters: `preserveWhitespace` - the new desired value ### public void setQuote([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") quote) Set Quote to use when printing attributes. Parameters: `quote` - the quote character groovy [Java] Class XmlSlurper [Java] Class XmlSlurper ======================= * groovy.xml.XmlSlurper ``` public class XmlSlurper extends [DefaultHandler](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/helpers/DefaultHandler.html "DefaultHandler") ``` Parse XML into a document tree that may be traversed similar to XPath expressions. For example: ``` import groovy.xml.XmlSlurper def rootNode = new XmlSlurper().parseText( '<root><one a1="uno!"/><two>Some text!</two></root>' ) assert rootNode.name() == 'root' assert rootNode.one[0].@a1 == 'uno!' assert rootNode.two.text() == 'Some text!' rootNode.children().each { assert it.name() in ['one','two'] } ``` Note that in some cases, a 'selector' expression may not resolve to a single node. For example: ``` import groovy.xml.XmlSlurper def rootNode = new XmlSlurper().parseText( '''<root> <a>one!</a> <a>two!</a> </root>''' ) assert rootNode.a.size() == 2 rootNode.a.each { assert it.text() in ['one!','two!'] } ``` See Also: [GPathResult](slurpersupport/gpathresult "GPathResult") Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[XmlSlurper](#XmlSlurper())()`Creates a non-validating and namespace-aware `XmlSlurper` which does not allow DOCTYPE declarations in documents. \| \| `[XmlSlurper](#XmlSlurper(boolean,%20boolean))(boolean validating, boolean namespaceAware)`Creates a `XmlSlurper` which does not allow DOCTYPE declarations in documents. \| \| `[XmlSlurper](#XmlSlurper(boolean,%20boolean,%20boolean))(boolean validating, boolean namespaceAware, boolean allowDocTypeDeclaration)`Creates a `XmlSlurper`. \| \| `[XmlSlurper](#XmlSlurper(org.xml.sax.XMLReader))([XMLReader](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/XMLReader.html "XMLReader") reader)` \| \| `[XmlSlurper](#XmlSlurper(javax.xml.parsers.SAXParser))([SAXParser](https://docs.oracle.com/javase/8/docs/api/javax/xml/parsers/SAXParser.html "SAXParser") parser)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public void` \| `[characters](#characters(char%5B%5D,%20int,%20int))(char[] ch, int start, int length)` \| \| \| `public void` \| `[endDocument](#endDocument())()` \| \| \| `public void` \| `[endElement](#endElement(java.lang.String,%20java.lang.String,%20java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") namespaceURI, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") localName, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") qName)` \| \| \| `public [DTDHandler](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/DTDHandler.html "DTDHandler")` \| `[getDTDHandler](#getDTDHandler())()` \| \| \| `public [GPathResult](slurpersupport/gpathresult)` \| `[getDocument](#getDocument())()` Returns: The GPathResult instance created by consuming a stream of SAX events Note if one of the parse methods has been called then this returns null Note if this is called more than once all calls after the first will return null \| \| \| `public [EntityResolver](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/EntityResolver.html "EntityResolver")` \| `[getEntityResolver](#getEntityResolver())()` \| \| \| `public [ErrorHandler](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/ErrorHandler.html "ErrorHandler")` \| `[getErrorHandler](#getErrorHandler())()` \| \| \| `public boolean` \| `[getFeature](#getFeature(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri)` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getProperty](#getProperty(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri)` \| \| \| `public void` \| `[ignorableWhitespace](#ignorableWhitespace(char%5B%5D,%20int,%20int))(char[] buffer, int start, int len)` \| \| \| `public boolean` \| `[isKeepIgnorableWhitespace](#isKeepIgnorableWhitespace())()` Returns: true if ignorable whitespace is kept \| \| \| `public [GPathResult](slurpersupport/gpathresult)` \| `[parse](#parse(org.xml.sax.InputSource))([InputSource](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/InputSource.html "InputSource") input)`Parse the content of the specified input source into a GPathResult object \| \| \| `public [GPathResult](slurpersupport/gpathresult)` \| `[parse](#parse(java.io.File))([File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File") file)`Parses the content of the given file as XML turning it into a GPathResult object \| \| \| `public [GPathResult](slurpersupport/gpathresult)` \| `[parse](#parse(java.io.InputStream))([InputStream](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html "InputStream") input)`Parse the content of the specified input stream into an GPathResult Object. \| \| \| `public [GPathResult](slurpersupport/gpathresult)` \| `[parse](#parse(java.io.Reader))([Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") in)`Parse the content of the specified reader into a GPathResult Object. \| \| \| `public [GPathResult](slurpersupport/gpathresult)` \| `[parse](#parse(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri)`Parse the content of the specified URI into a GPathResult Object \| \| \| `public [GPathResult](slurpersupport/gpathresult)` \| `[parse](#parse(java.nio.file.Path))([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") path)` \| \| \| `public [GPathResult](slurpersupport/gpathresult)` \| `[parseText](#parseText(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text)`A helper method to parse the given text as XML \| \| \| `public void` \| `[setDTDHandler](#setDTDHandler(org.xml.sax.DTDHandler))([DTDHandler](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/DTDHandler.html "DTDHandler") dtdHandler)` \| \| \| `public void` \| `[setEntityBaseUrl](#setEntityBaseUrl(java.net.URL))([URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html "URL") base)`Resolves entities against using the supplied URL as the base for relative URLs \| \| \| `public void` \| `[setEntityResolver](#setEntityResolver(org.xml.sax.EntityResolver))([EntityResolver](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/EntityResolver.html "EntityResolver") entityResolver)` \| \| \| `public void` \| `[setErrorHandler](#setErrorHandler(org.xml.sax.ErrorHandler))([ErrorHandler](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/ErrorHandler.html "ErrorHandler") errorHandler)` \| \| \| `public void` \| `[setFeature](#setFeature(java.lang.String,%20boolean))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri, boolean value)` \| \| \| `public void` \| `[setKeepIgnorableWhitespace](#setKeepIgnorableWhitespace(boolean))(boolean keepIgnorableWhitespace)` Parameters: `keepIgnorableWhitespace` - If true then ignorable whitespace (i.e. whitespace before elements) is kept. \| \| \| `public void` \| `[setKeepWhitespace](#setKeepWhitespace(boolean))(boolean keepWhitespace)` deprecated: use setKeepIgnorableWhitespace \| \| \| `public void` \| `[setProperty](#setProperty(java.lang.String,%20java.lang.Object))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| \| \| `public void` \| `[startDocument](#startDocument())()` \| \| \| `public void` \| `[startElement](#startElement(java.lang.String,%20java.lang.String,%20java.lang.String,%20org.xml.sax.Attributes))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") namespaceURI, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") localName, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") qName, [Attributes](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/Attributes.html "Attributes") atts)` \| \| \| `public void` \| `[startPrefixMapping](#startPrefixMapping(java.lang.String,%20java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") tag, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [DefaultHandler](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/helpers/DefaultHandler.html "DefaultHandler")` \| `[error](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/helpers/DefaultHandler.html#error(org.xml.sax.SAXParseException) "error"), [warning](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/helpers/DefaultHandler.html#warning(org.xml.sax.SAXParseException) "warning"), [unparsedEntityDecl](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/helpers/DefaultHandler.html#unparsedEntityDecl(java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String) "unparsedEntityDecl"), [notationDecl](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/helpers/DefaultHandler.html#notationDecl(java.lang.String,%20java.lang.String,%20java.lang.String) "notationDecl"), [setDocumentLocator](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/helpers/DefaultHandler.html#setDocumentLocator(org.xml.sax.Locator) "setDocumentLocator"), [startDocument](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/helpers/DefaultHandler.html#startDocument() "startDocument"), [endDocument](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/helpers/DefaultHandler.html#endDocument() "endDocument"), [startPrefixMapping](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/helpers/DefaultHandler.html#startPrefixMapping(java.lang.String,%20java.lang.String) "startPrefixMapping"), [endPrefixMapping](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/helpers/DefaultHandler.html#endPrefixMapping(java.lang.String) "endPrefixMapping"), [startElement](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/helpers/DefaultHandler.html#startElement(java.lang.String,%20java.lang.String,%20java.lang.String,%20org.xml.sax.Attributes) "startElement"), [endElement](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/helpers/DefaultHandler.html#endElement(java.lang.String,%20java.lang.String,%20java.lang.String) "endElement"), [characters](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/helpers/DefaultHandler.html#characters(%5BC,%20int,%20int) "characters"), [ignorableWhitespace](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/helpers/DefaultHandler.html#ignorableWhitespace(%5BC,%20int,%20int) "ignorableWhitespace"), [processingInstruction](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/helpers/DefaultHandler.html#processingInstruction(java.lang.String,%20java.lang.String) "processingInstruction"), [skippedEntity](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/helpers/DefaultHandler.html#skippedEntity(java.lang.String) "skippedEntity"), [resolveEntity](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/helpers/DefaultHandler.html#resolveEntity(java.lang.String,%20java.lang.String) "resolveEntity"), [fatalError](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/helpers/DefaultHandler.html#fatalError(org.xml.sax.SAXParseException) "fatalError"), [wait](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/helpers/DefaultHandler.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/helpers/DefaultHandler.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/helpers/DefaultHandler.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/helpers/DefaultHandler.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/helpers/DefaultHandler.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/helpers/DefaultHandler.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/helpers/DefaultHandler.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/helpers/DefaultHandler.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/helpers/DefaultHandler.html#notifyAll() "notifyAll"), [declaration](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/helpers/DefaultHandler.html#declaration(java.lang.String,%20java.lang.String,%20java.lang.String) "declaration")` \| Constructor Detail ------------------ ### public XmlSlurper() Creates a non-validating and namespace-aware `XmlSlurper` which does not allow DOCTYPE declarations in documents. throws: ParserConfigurationException if no parser which satisfies the requested configuration can be created. throws: SAXException for SAX errors. ### public XmlSlurper(boolean validating, boolean namespaceAware) Creates a `XmlSlurper` which does not allow DOCTYPE declarations in documents. throws: ParserConfigurationException if no parser which satisfies the requested configuration can be created. throws: SAXException for SAX errors. Parameters: `validating` - `true` if the parser should validate documents as they are parsed; false otherwise. `namespaceAware` - `true` if the parser should provide support for XML namespaces; `false` otherwise. ### public XmlSlurper(boolean validating, boolean namespaceAware, boolean allowDocTypeDeclaration) Creates a `XmlSlurper`. throws: ParserConfigurationException if no parser which satisfies the requested configuration can be created. throws: SAXException for SAX errors. Parameters: `validating` - `true` if the parser should validate documents as they are parsed; false otherwise. `namespaceAware` - `true` if the parser should provide support for XML namespaces; `false` otherwise. `allowDocTypeDeclaration` - `true` if the parser should provide support for DOCTYPE declarations; `false` otherwise. ### public XmlSlurper([XMLReader](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/XMLReader.html "XMLReader") reader) ### public XmlSlurper([SAXParser](https://docs.oracle.com/javase/8/docs/api/javax/xml/parsers/SAXParser.html "SAXParser") parser) Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void characters(char[] ch, int start, int length) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void endDocument() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void endElement([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") namespaceURI, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") localName, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") qName) ### public [DTDHandler](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/DTDHandler.html "DTDHandler") getDTDHandler() ### public [GPathResult](slurpersupport/gpathresult) getDocument() Returns: The GPathResult instance created by consuming a stream of SAX events Note if one of the parse methods has been called then this returns null Note if this is called more than once all calls after the first will return null ### public [EntityResolver](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/EntityResolver.html "EntityResolver") getEntityResolver() ### public [ErrorHandler](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/ErrorHandler.html "ErrorHandler") getErrorHandler() ### public boolean getFeature([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri) ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getProperty([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void ignorableWhitespace(char[] buffer, int start, int len) ### public boolean isKeepIgnorableWhitespace() Returns: true if ignorable whitespace is kept ### public [GPathResult](slurpersupport/gpathresult) parse([InputSource](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/InputSource.html "InputSource") input) Parse the content of the specified input source into a GPathResult object throws: SAXException Any SAX exception, possibly wrapping another exception. throws: IOException An IO exception from the parser, possibly from a byte stream or character stream supplied by the application. Parameters: `input` - the InputSource to parse Returns: An object which supports GPath expressions ### public [GPathResult](slurpersupport/gpathresult) parse([File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File") file) Parses the content of the given file as XML turning it into a GPathResult object throws: SAXException Any SAX exception, possibly wrapping another exception. throws: IOException An IO exception from the parser, possibly from a byte stream or character stream supplied by the application. Parameters: `file` - the File to parse Returns: An object which supports GPath expressions ### public [GPathResult](slurpersupport/gpathresult) parse([InputStream](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html "InputStream") input) Parse the content of the specified input stream into an GPathResult Object. Note that using this method will not provide the parser with any URI for which to find DTDs etc. It is up to you to close the InputStream after parsing is complete (if required). throws: SAXException Any SAX exception, possibly wrapping another exception. throws: IOException An IO exception from the parser, possibly from a byte stream or character stream supplied by the application. Parameters: `input` - the InputStream to parse Returns: An object which supports GPath expressions ### public [GPathResult](slurpersupport/gpathresult) parse([Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") in) Parse the content of the specified reader into a GPathResult Object. Note that using this method will not provide the parser with any URI for which to find DTDs etc. It is up to you to close the Reader after parsing is complete (if required). throws: SAXException Any SAX exception, possibly wrapping another exception. throws: IOException An IO exception from the parser, possibly from a byte stream or character stream supplied by the application. Parameters: `in` - the Reader to parse Returns: An object which supports GPath expressions ### public [GPathResult](slurpersupport/gpathresult) parse([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri) Parse the content of the specified URI into a GPathResult Object throws: SAXException Any SAX exception, possibly wrapping another exception. throws: IOException An IO exception from the parser, possibly from a byte stream or character stream supplied by the application. Parameters: `uri` - a String containing the URI to parse Returns: An object which supports GPath expressions ### public [GPathResult](slurpersupport/gpathresult) parse([Path](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html "Path") path) ### public [GPathResult](slurpersupport/gpathresult) parseText([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text) A helper method to parse the given text as XML throws: SAXException Any SAX exception, possibly wrapping another exception. throws: IOException An IO exception from the parser, possibly from a byte stream or character stream supplied by the application. Parameters: `text` - a String containing XML to parse Returns: An object which supports GPath expressions ### public void setDTDHandler([DTDHandler](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/DTDHandler.html "DTDHandler") dtdHandler) ### public void setEntityBaseUrl([URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html "URL") base) Resolves entities against using the supplied URL as the base for relative URLs Parameters: `base` - The URL used to resolve relative URLs ### public void setEntityResolver([EntityResolver](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/EntityResolver.html "EntityResolver") entityResolver) ### public void setErrorHandler([ErrorHandler](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/ErrorHandler.html "ErrorHandler") errorHandler) ### public void setFeature([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri, boolean value) ### public void setKeepIgnorableWhitespace(boolean keepIgnorableWhitespace) Parameters: `keepIgnorableWhitespace` - If true then ignorable whitespace (i.e. whitespace before elements) is kept. The default is to discard the whitespace. ### @[Deprecated](https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html "Deprecated") public void setKeepWhitespace(boolean keepWhitespace) deprecated: use setKeepIgnorableWhitespace Parameters: `keepWhitespace` - If true then whitespace before elements is kept. The default is to discard the whitespace. ### public void setProperty([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void startDocument() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void startElement([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") namespaceURI, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") localName, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") qName, [Attributes](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/Attributes.html "Attributes") atts) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void startPrefixMapping([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") tag, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri)	programming_docs
groovy [Java] Class SAXBuilder [Java] Class SAXBuilder ======================= * groovy.xml.SAXBuilder ``` public class SAXBuilder extends [BuilderSupport](../util/buildersupport) ``` A builder for generating W3C SAX events. Use similar to MarkupBuilder. Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[SAXBuilder](#SAXBuilder(org.xml.sax.ContentHandler))([ContentHandler](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/ContentHandler.html "ContentHandler") handler)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[createNode](#createNode(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name)` \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[createNode](#createNode(java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[createNode](#createNode(java.lang.Object,%20java.util.Map,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributeMap, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") text)` \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[createNode](#createNode(java.lang.Object,%20java.util.Map))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| \| \| `protected void` \| `[doStartElement](#doStartElement(java.lang.Object,%20org.xml.sax.Attributes))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Attributes](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/Attributes.html "Attributes") attributes)` \| \| \| `protected void` \| `[handleException](#handleException(org.xml.sax.SAXException))([SAXException](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/SAXException.html "SAXException") e)` \| \| \| `protected void` \| `[nodeCompleted](#nodeCompleted(java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name)` \| \| \| `protected void` \| `[setParent](#setParent(java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [BuilderSupport](../util/buildersupport)` \| `[createNode](../util/buildersupport#createNode(java.lang.Object)), [createNode](../util/buildersupport#createNode(java.lang.Object,%20java.lang.Object)), [createNode](../util/buildersupport#createNode(java.lang.Object,%20java.util.Map)), [createNode](../util/buildersupport#createNode(java.lang.Object,%20java.util.Map,%20java.lang.Object)), [doInvokeMethod](../util/buildersupport#doInvokeMethod(java.lang.String,%20java.lang.Object,%20java.lang.Object)), [getCurrent](../util/buildersupport#getCurrent()), [getName](../util/buildersupport#getName(java.lang.String)), [invokeMethod](../util/buildersupport#invokeMethod(java.lang.String)), [invokeMethod](../util/buildersupport#invokeMethod(java.lang.String,%20java.lang.Object)), [nodeCompleted](../util/buildersupport#nodeCompleted(java.lang.Object,%20java.lang.Object)), [postNodeCompletion](../util/buildersupport#postNodeCompletion(java.lang.Object,%20java.lang.Object)), [setClosureDelegate](../util/buildersupport#setClosureDelegate(groovy.lang.Closure,%20java.lang.Object)), [setCurrent](../util/buildersupport#setCurrent(java.lang.Object)), [setParent](../util/buildersupport#setParent(java.lang.Object,%20java.lang.Object))` \| \| `class [GroovyObjectSupport](../lang/groovyobjectsupport)` \| `[getMetaClass](../lang/groovyobjectsupport#getMetaClass()), [setMetaClass](../lang/groovyobjectsupport#setMetaClass(groovy.lang.MetaClass))` \| Constructor Detail ------------------ ### public SAXBuilder([ContentHandler](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/ContentHandler.html "ContentHandler") handler) Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") createNode([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") createNode([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") createNode([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributeMap, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") text) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") createNode([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) ### protected void doStartElement([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Attributes](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/Attributes.html "Attributes") attributes) ### protected void handleException([SAXException](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/SAXException.html "SAXException") e) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected void nodeCompleted([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected void setParent([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child) groovy [Java] Class DOMBuilder [Java] Class DOMBuilder ======================= * groovy.xml.DOMBuilder ``` public class DOMBuilder extends [BuilderSupport](../util/buildersupport) ``` A helper class for creating a W3C DOM tree Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[DOMBuilder](#DOMBuilder(javax.swing.text.Document))([Document](https://docs.oracle.com/javase/8/docs/api/javax/swing/text/Document.html "Document") document)` \| \| `[DOMBuilder](#DOMBuilder(javax.xml.parsers.DocumentBuilder))([DocumentBuilder](https://docs.oracle.com/javase/8/docs/api/javax/xml/parsers/DocumentBuilder.html "DocumentBuilder") documentBuilder)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `protected void` \| `[appendNamespaceAttributes](#appendNamespaceAttributes(javax.swing.text.Element,%20Map))([Element](https://docs.oracle.com/javase/8/docs/api/javax/swing/text/Element.html "Element") element, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object"), [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")> attributes)` \| \| \| `protected [Document](https://docs.oracle.com/javase/8/docs/api/javax/swing/text/Document.html "Document")` \| `[createDocument](#createDocument())()` \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[createNode](#createNode(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name)` \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[createNode](#createNode(java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[createNode](#createNode(java.lang.Object,%20java.util.Map,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[createNode](#createNode(java.lang.Object,%20java.util.Map))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| \| \| `public static [DOMBuilder](dombuilder)` \| `[newInstance](#newInstance())()` \| \| \| `public static [DOMBuilder](dombuilder)` \| `[newInstance](#newInstance(boolean,%20boolean))(boolean validating, boolean namespaceAware)` \| \| \| `public static [Document](https://docs.oracle.com/javase/8/docs/api/javax/swing/text/Document.html "Document")` \| `[parse](#parse(java.io.Reader))([Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") reader)`Creates a DocumentBuilder and uses it to parse the XML text read from the given reader. \| \| \| `public static [Document](https://docs.oracle.com/javase/8/docs/api/javax/swing/text/Document.html "Document")` \| `[parse](#parse(java.io.Reader,%20boolean,%20boolean))([Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") reader, boolean validating, boolean namespaceAware)`Creates a DocumentBuilder and uses it to parse the XML text read from the given reader, allowing parser validation and namespace awareness to be controlled. \| \| \| `public static [Document](https://docs.oracle.com/javase/8/docs/api/javax/swing/text/Document.html "Document")` \| `[parse](#parse(java.io.Reader,%20boolean,%20boolean,%20boolean))([Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") reader, boolean validating, boolean namespaceAware, boolean allowDocTypeDeclaration)`Creates a DocumentBuilder and uses it to parse the XML text read from the given reader, allowing parser validation, namespace awareness and permission of DOCTYPE declarations to be controlled. \| \| \| `public [Document](https://docs.oracle.com/javase/8/docs/api/javax/swing/text/Document.html "Document")` \| `[parseText](#parseText(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text)`A helper method to parse the given text as XML. \| \| \| `protected void` \| `[setParent](#setParent(java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [BuilderSupport](../util/buildersupport)` \| `[createNode](../util/buildersupport#createNode(java.lang.Object)), [createNode](../util/buildersupport#createNode(java.lang.Object,%20java.lang.Object)), [createNode](../util/buildersupport#createNode(java.lang.Object,%20java.util.Map)), [createNode](../util/buildersupport#createNode(java.lang.Object,%20java.util.Map,%20java.lang.Object)), [doInvokeMethod](../util/buildersupport#doInvokeMethod(java.lang.String,%20java.lang.Object,%20java.lang.Object)), [getCurrent](../util/buildersupport#getCurrent()), [getName](../util/buildersupport#getName(java.lang.String)), [invokeMethod](../util/buildersupport#invokeMethod(java.lang.String)), [invokeMethod](../util/buildersupport#invokeMethod(java.lang.String,%20java.lang.Object)), [nodeCompleted](../util/buildersupport#nodeCompleted(java.lang.Object,%20java.lang.Object)), [postNodeCompletion](../util/buildersupport#postNodeCompletion(java.lang.Object,%20java.lang.Object)), [setClosureDelegate](../util/buildersupport#setClosureDelegate(groovy.lang.Closure,%20java.lang.Object)), [setCurrent](../util/buildersupport#setCurrent(java.lang.Object)), [setParent](../util/buildersupport#setParent(java.lang.Object,%20java.lang.Object))` \| \| `class [GroovyObjectSupport](../lang/groovyobjectsupport)` \| `[getMetaClass](../lang/groovyobjectsupport#getMetaClass()), [setMetaClass](../lang/groovyobjectsupport#setMetaClass(groovy.lang.MetaClass))` \| Constructor Detail ------------------ ### public DOMBuilder([Document](https://docs.oracle.com/javase/8/docs/api/javax/swing/text/Document.html "Document") document) ### public DOMBuilder([DocumentBuilder](https://docs.oracle.com/javase/8/docs/api/javax/xml/parsers/DocumentBuilder.html "DocumentBuilder") documentBuilder) Method Detail ------------- ### protected void appendNamespaceAttributes([Element](https://docs.oracle.com/javase/8/docs/api/javax/swing/text/Element.html "Element") element, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object"), [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")> attributes) ### protected [Document](https://docs.oracle.com/javase/8/docs/api/javax/swing/text/Document.html "Document") createDocument() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") createNode([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") createNode([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") createNode([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") createNode([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) ### public static [DOMBuilder](dombuilder) newInstance() ### public static [DOMBuilder](dombuilder) newInstance(boolean validating, boolean namespaceAware) ### public static [Document](https://docs.oracle.com/javase/8/docs/api/javax/swing/text/Document.html "Document") parse([Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") reader) Creates a DocumentBuilder and uses it to parse the XML text read from the given reader. A non-validating, namespace aware parser which does not allow DOCTYPE declarations is used. throws: SAXException Any SAX exception, possibly wrapping another exception. throws: IOException An IO exception from the parser, possibly from a byte stream or character stream supplied by the application. throws: ParserConfigurationException if a DocumentBuilder cannot be created which satisfies the configuration requested. Parameters: `reader` - the reader to read the XML text from Returns: the root node of the parsed tree of Nodes See Also: [parse(Reader, boolean, boolean)](#parse(java.io.Reader,%20boolean,%20boolean)) ### public static [Document](https://docs.oracle.com/javase/8/docs/api/javax/swing/text/Document.html "Document") parse([Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") reader, boolean validating, boolean namespaceAware) Creates a DocumentBuilder and uses it to parse the XML text read from the given reader, allowing parser validation and namespace awareness to be controlled. Documents are not allowed to contain DOCYTYPE declarations. throws: SAXException Any SAX exception, possibly wrapping another exception. throws: IOException An IO exception from the parser, possibly from a byte stream or character stream supplied by the application. throws: ParserConfigurationException if a DocumentBuilder cannot be created which satisfies the configuration requested. Parameters: `reader` - the reader to read the XML text from `validating` - whether to validate the XML `namespaceAware` - whether the parser should be namespace aware Returns: the root node of the parsed tree of Nodes ### public static [Document](https://docs.oracle.com/javase/8/docs/api/javax/swing/text/Document.html "Document") parse([Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") reader, boolean validating, boolean namespaceAware, boolean allowDocTypeDeclaration) Creates a DocumentBuilder and uses it to parse the XML text read from the given reader, allowing parser validation, namespace awareness and permission of DOCTYPE declarations to be controlled. throws: SAXException Any SAX exception, possibly wrapping another exception. throws: IOException An IO exception from the parser, possibly from a byte stream or character stream supplied by the application. throws: ParserConfigurationException if a DocumentBuilder cannot be created which satisfies the configuration requested. Parameters: `reader` - the reader to read the XML text from `validating` - whether to validate the XML `namespaceAware` - whether the parser should be namespace aware `allowDocTypeDeclaration` - whether the parser should allow DOCTYPE declarations Returns: the root node of the parsed tree of Nodes ### public [Document](https://docs.oracle.com/javase/8/docs/api/javax/swing/text/Document.html "Document") parseText([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text) A helper method to parse the given text as XML. throws: SAXException Any SAX exception, possibly wrapping another exception. throws: IOException An IO exception from the parser, possibly from a byte stream or character stream supplied by the application. throws: ParserConfigurationException if a DocumentBuilder cannot be created which satisfies the configuration requested. Parameters: `text` - the XML text to parse Returns: the root node of the parsed tree of Nodes See Also: [parse(Reader)](#parse(java.io.Reader)) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected void setParent([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child)	programming_docs
groovy [Java] Class MarkupBuilder.DefaultXmlEscapingFunction [Java] Class MarkupBuilder.DefaultXmlEscapingFunction ===================================================== * groovy.xml.MarkupBuilder.DefaultXmlEscapingFunction All Implemented Interfaces and Traits: [Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function") ``` public static class MarkupBuilder.DefaultXmlEscapingFunction ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[DefaultXmlEscapingFunction](#DefaultXmlEscapingFunction(boolean,%20boolean))(boolean isAttrValue, boolean useDoubleQuotes)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [Optional](https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html "Optional")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>` \| `[apply](#apply(java.lang.Character))([Character](https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html "Character") ch)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public DefaultXmlEscapingFunction(boolean isAttrValue, boolean useDoubleQuotes) Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Optional](https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html "Optional")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> apply([Character](https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html "Character") ch) groovy [Java] Class MarkupBuilderHelper [Java] Class MarkupBuilderHelper ================================ * groovy.xml.MarkupBuilderHelper ``` public class MarkupBuilderHelper extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` A helper class for MarkupBuilder. Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[MarkupBuilderHelper](#MarkupBuilderHelper(groovy.xml.MarkupBuilder))([MarkupBuilder](markupbuilder) builder)` Parameters: `builder` - the builder to delegate to \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public void` \| `[comment](#comment(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") value)`Produce a comment in the output. \| \| \| `public void` \| `[pi](#pi(Map))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")>> args)`Produce an XML processing instruction in the output. \| \| \| `public void` \| `[xmlDeclaration](#xmlDeclaration(Map))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")> args)`Produce an XML declaration in the output. \| \| \| `public void` \| `[yield](#yield(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)`Prints data in the body of the current tag, escaping XML entities. \| \| \| `public void` \| `[yield](#yield(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") value)`Prints data in the body of the current tag, escaping XML entities. \| \| \| `public void` \| `[yieldUnescaped](#yieldUnescaped(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)`Print data in the body of the current tag. \| \| \| `public void` \| `[yieldUnescaped](#yieldUnescaped(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") value)`Print data in the body of the current tag. \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public MarkupBuilderHelper([MarkupBuilder](markupbuilder) builder) Parameters: `builder` - the builder to delegate to Method Detail ------------- ### public void comment([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") value) Produce a comment in the output. `mkp.comment 'string'` is equivalent to `mkp.yieldUnescaped '<!-- string -->'`. To create an element with the name 'comment', you need to supply empty attributes, e.g.: ``` comment('hello1') ``` or ``` mkp.comment('hello1') ``` will produce: ``` <!-- hello1 --> ``` while: ``` comment('hello2', [:]) ``` will produce: ``` <comment>hello2</comment> ``` Parameters: `value` - the text within the comment. ### public void pi([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")>> args) Produce an XML processing instruction in the output. For example: ``` mkp.pi("xml-stylesheet":[href:"mystyle.css", type:"text/css"]) ``` Parameters: `args` - a map with a single entry whose key is the name of the processing instruction and whose value is the attributes for the processing instruction. ### public void xmlDeclaration([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")> args) Produce an XML declaration in the output. For example: ``` mkp.xmlDeclaration(version:'1.0') ``` Parameters: `args` - the attributes for the declaration ### public void yield([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) Prints data in the body of the current tag, escaping XML entities. For example: `mkp.yield('5 < 7')` Parameters: `value` - an Object whose toString() representation is to be printed ### public void yield([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") value) Prints data in the body of the current tag, escaping XML entities. For example: `mkp.yield('5 < 7')` Parameters: `value` - text to print ### public void yieldUnescaped([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) Print data in the body of the current tag. Does not escape XML entities. For example: `mkp.yieldUnescaped('I am <i>happy</i>!')`. Parameters: `value` - an Object whose toString() representation is to be printed ### public void yieldUnescaped([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") value) Print data in the body of the current tag. Does not escape XML entities. For example: `mkp.yieldUnescaped('I am <i>happy</i>!')`. Parameters: `value` - the text or markup to print. groovy [Java] Class NamespaceBuilderSupport [Java] Class NamespaceBuilderSupport ==================================== * groovy.xml.NamespaceBuilderSupport ``` public class NamespaceBuilderSupport extends [BuilderSupport](../util/buildersupport) ``` A helper class for creating namespaced GroovyMarkup Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[NamespaceBuilderSupport](#NamespaceBuilderSupport(groovy.util.BuilderSupport))([BuilderSupport](../util/buildersupport) builder)` \| \| `[NamespaceBuilderSupport](#NamespaceBuilderSupport(groovy.util.BuilderSupport,%20java.lang.String))([BuilderSupport](../util/buildersupport) builder, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri)` \| \| `[NamespaceBuilderSupport](#NamespaceBuilderSupport(groovy.util.BuilderSupport,%20java.lang.String,%20java.lang.String))([BuilderSupport](../util/buildersupport) builder, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") prefix)` \| \| `[NamespaceBuilderSupport](#NamespaceBuilderSupport(groovy.util.BuilderSupport,%20java.lang.String,%20java.lang.String,%20boolean))([BuilderSupport](../util/buildersupport) builder, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") prefix, boolean autoPrefix)` \| \| `[NamespaceBuilderSupport](#NamespaceBuilderSupport(groovy.util.BuilderSupport,%20java.util.Map))([BuilderSupport](../util/buildersupport) builder, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") nsMap)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[createNode](#createNode(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name)` \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[createNode](#createNode(java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[createNode](#createNode(java.lang.Object,%20java.util.Map))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[createNode](#createNode(java.lang.Object,%20java.util.Map,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| \| \| `public [NamespaceBuilderSupport](namespacebuildersupport)` \| `[declareNamespace](#declareNamespace(java.util.Map))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") nsMap)` \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getCurrent](#getCurrent())()` \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getName](#getName(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName)` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[invokeMethod](#invokeMethod(java.lang.String,%20java.lang.Object))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args)`Allow automatic detection of namespace declared in the attributes \| \| \| `public [NamespaceBuilderSupport](namespacebuildersupport)` \| `[namespace](#namespace(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") namespaceURI)` \| \| \| `public [NamespaceBuilderSupport](namespacebuildersupport)` \| `[namespace](#namespace(java.lang.String,%20java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") namespaceURI, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") prefix)` \| \| \| `protected void` \| `[setCurrent](#setCurrent(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") current)` \| \| \| `protected void` \| `[setParent](#setParent(java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [BuilderSupport](../util/buildersupport)` \| `[createNode](../util/buildersupport#createNode(java.lang.Object)), [createNode](../util/buildersupport#createNode(java.lang.Object,%20java.lang.Object)), [createNode](../util/buildersupport#createNode(java.lang.Object,%20java.util.Map)), [createNode](../util/buildersupport#createNode(java.lang.Object,%20java.util.Map,%20java.lang.Object)), [doInvokeMethod](../util/buildersupport#doInvokeMethod(java.lang.String,%20java.lang.Object,%20java.lang.Object)), [getCurrent](../util/buildersupport#getCurrent()), [getName](../util/buildersupport#getName(java.lang.String)), [invokeMethod](../util/buildersupport#invokeMethod(java.lang.String)), [invokeMethod](../util/buildersupport#invokeMethod(java.lang.String,%20java.lang.Object)), [nodeCompleted](../util/buildersupport#nodeCompleted(java.lang.Object,%20java.lang.Object)), [postNodeCompletion](../util/buildersupport#postNodeCompletion(java.lang.Object,%20java.lang.Object)), [setClosureDelegate](../util/buildersupport#setClosureDelegate(groovy.lang.Closure,%20java.lang.Object)), [setCurrent](../util/buildersupport#setCurrent(java.lang.Object)), [setParent](../util/buildersupport#setParent(java.lang.Object,%20java.lang.Object))` \| \| `class [GroovyObjectSupport](../lang/groovyobjectsupport)` \| `[getMetaClass](../lang/groovyobjectsupport#getMetaClass()), [setMetaClass](../lang/groovyobjectsupport#setMetaClass(groovy.lang.MetaClass))` \| Constructor Detail ------------------ ### public NamespaceBuilderSupport([BuilderSupport](../util/buildersupport) builder) ### public NamespaceBuilderSupport([BuilderSupport](../util/buildersupport) builder, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri) ### public NamespaceBuilderSupport([BuilderSupport](../util/buildersupport) builder, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") prefix) ### public NamespaceBuilderSupport([BuilderSupport](../util/buildersupport) builder, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") prefix, boolean autoPrefix) ### public NamespaceBuilderSupport([BuilderSupport](../util/buildersupport) builder, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") nsMap) Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") createNode([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") createNode([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") createNode([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") createNode([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) ### public [NamespaceBuilderSupport](namespacebuildersupport) declareNamespace([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") nsMap) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getCurrent() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getName([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") invokeMethod([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") args) Allow automatic detection of namespace declared in the attributes ### public [NamespaceBuilderSupport](namespacebuildersupport) namespace([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") namespaceURI) ### public [NamespaceBuilderSupport](namespacebuildersupport) namespace([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") namespaceURI, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") prefix) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected void setCurrent([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") current) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected void setParent([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child)	programming_docs
groovy [Groovy] Class Entity [Groovy] Class Entity ===================== * groovy.xml.Entity All Implemented Interfaces and Traits: [Buildable](../lang/buildable) ``` class Entity extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") implements [Buildable](../lang/buildable) ``` Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `static [Entity](entity)` \| `[AElig](#AElig)` \| \| \| `static [Entity](entity)` \| `[Aacute](#Aacute)` \| \| \| `static [Entity](entity)` \| `[Acirc](#Acirc)` \| \| \| `static [Entity](entity)` \| `[Agrave](#Agrave)` \| \| \| `static [Entity](entity)` \| `[Aring](#Aring)` \| \| \| `static [Entity](entity)` \| `[Atilde](#Atilde)` \| \| \| `static [Entity](entity)` \| `[Auml](#Auml)` \| \| \| `static [Entity](entity)` \| `[Ccedil](#Ccedil)` \| \| \| `static [Entity](entity)` \| `[Dagger](#Dagger)` \| \| \| `static [Entity](entity)` \| `[ETH](#ETH)` \| \| \| `static [Entity](entity)` \| `[Eacute](#Eacute)` \| \| \| `static [Entity](entity)` \| `[Ecirc](#Ecirc)` \| \| \| `static [Entity](entity)` \| `[Egrave](#Egrave)` \| \| \| `static [Entity](entity)` \| `[Euml](#Euml)` \| \| \| `static [Entity](entity)` \| `[Iacute](#Iacute)` \| \| \| `static [Entity](entity)` \| `[Icirc](#Icirc)` \| \| \| `static [Entity](entity)` \| `[Igrave](#Igrave)` \| \| \| `static [Entity](entity)` \| `[Iuml](#Iuml)` \| \| \| `static [Entity](entity)` \| `[Ntilde](#Ntilde)` \| \| \| `static [Entity](entity)` \| `[OElig](#OElig)` \| \| \| `static [Entity](entity)` \| `[Oacute](#Oacute)` \| \| \| `static [Entity](entity)` \| `[Ocirc](#Ocirc)` \| \| \| `static [Entity](entity)` \| `[Ograve](#Ograve)` \| \| \| `static [Entity](entity)` \| `[Oslash](#Oslash)` \| \| \| `static [Entity](entity)` \| `[Otilde](#Otilde)` \| \| \| `static [Entity](entity)` \| `[Ouml](#Ouml)` \| \| \| `static [Entity](entity)` \| `[Scaron](#Scaron)` \| \| \| `static [Entity](entity)` \| `[THORN](#THORN)` \| \| \| `static [Entity](entity)` \| `[Uacute](#Uacute)` \| \| \| `static [Entity](entity)` \| `[Ucirc](#Ucirc)` \| \| \| `static [Entity](entity)` \| `[Ugrave](#Ugrave)` \| \| \| `static [Entity](entity)` \| `[Uuml](#Uuml)` \| \| \| `static [Entity](entity)` \| `[Yacute](#Yacute)` \| \| \| `static [Entity](entity)` \| `[Yuml](#Yuml)` \| \| \| `static [Entity](entity)` \| `[aacute](#aacute)` \| \| \| `static [Entity](entity)` \| `[acirc](#acirc)` \| \| \| `static [Entity](entity)` \| `[acute](#acute)` \| \| \| `static [Entity](entity)` \| `[aelig](#aelig)` \| \| \| `static [Entity](entity)` \| `[agrave](#agrave)` \| \| \| `static [Entity](entity)` \| `[amp](#amp)` \| \| \| `static [Entity](entity)` \| `[apos](#apos)` \| \| \| `static [Entity](entity)` \| `[aring](#aring)` \| \| \| `static [Entity](entity)` \| `[atilde](#atilde)` \| \| \| `static [Entity](entity)` \| `[auml](#auml)` \| \| \| `static [Entity](entity)` \| `[bdquo](#bdquo)` \| \| \| `static [Entity](entity)` \| `[brvbar](#brvbar)` \| \| \| `static [Entity](entity)` \| `[ccedil](#ccedil)` \| \| \| `static [Entity](entity)` \| `[cedil](#cedil)` \| \| \| `static [Entity](entity)` \| `[cent](#cent)` \| \| \| `static [Entity](entity)` \| `[circ](#circ)` \| \| \| `static [Entity](entity)` \| `[copy](#copy)` \| \| \| `static [Entity](entity)` \| `[curren](#curren)` \| \| \| `static [Entity](entity)` \| `[dagger](#dagger)` \| \| \| `static [Entity](entity)` \| `[deg](#deg)` \| \| \| `static [Entity](entity)` \| `[divide](#divide)` \| \| \| `static [Entity](entity)` \| `[eacute](#eacute)` \| \| \| `static [Entity](entity)` \| `[ecirc](#ecirc)` \| \| \| `static [Entity](entity)` \| `[egrave](#egrave)` \| \| \| `static [Entity](entity)` \| `[emsp](#emsp)` \| \| \| `static [Entity](entity)` \| `[ensp](#ensp)` \| \| \| `static [Entity](entity)` \| `[eth](#eth)` \| \| \| `static [Entity](entity)` \| `[euml](#euml)` \| \| \| `static [Entity](entity)` \| `[euro](#euro)` \| \| \| `static [Entity](entity)` \| `[frac12](#frac12)` \| \| \| `static [Entity](entity)` \| `[frac14](#frac14)` \| \| \| `static [Entity](entity)` \| `[frac34](#frac34)` \| \| \| `static [Entity](entity)` \| `[gt](#gt)` \| \| \| `static [Entity](entity)` \| `[iacute](#iacute)` \| \| \| `static [Entity](entity)` \| `[icirc](#icirc)` \| \| \| `static [Entity](entity)` \| `[iexcl](#iexcl)` \| \| \| `static [Entity](entity)` \| `[igrave](#igrave)` \| \| \| `static [Entity](entity)` \| `[iquest](#iquest)` \| \| \| `static [Entity](entity)` \| `[iuml](#iuml)` \| \| \| `static [Entity](entity)` \| `[laquo](#laquo)` \| \| \| `static [Entity](entity)` \| `[ldquo](#ldquo)` \| \| \| `static [Entity](entity)` \| `[lrm](#lrm)` \| \| \| `static [Entity](entity)` \| `[lsaquo](#lsaquo)` \| \| \| `static [Entity](entity)` \| `[lsquo](#lsquo)` \| \| \| `static [Entity](entity)` \| `[lt](#lt)` \| \| \| `static [Entity](entity)` \| `[macr](#macr)` \| \| \| `static [Entity](entity)` \| `[mdash](#mdash)` \| \| \| `static [Entity](entity)` \| `[micro](#micro)` \| \| \| `static [Entity](entity)` \| `[middot](#middot)` \| \| \| `static [Entity](entity)` \| `[nbsp](#nbsp)` \| \| \| `static [Entity](entity)` \| `[ndash](#ndash)` \| \| \| `static [Entity](entity)` \| `[not](#not)` \| \| \| `static [Entity](entity)` \| `[ntilde](#ntilde)` \| \| \| `static [Entity](entity)` \| `[oacute](#oacute)` \| \| \| `static [Entity](entity)` \| `[ocirc](#ocirc)` \| \| \| `static [Entity](entity)` \| `[oelig](#oelig)` \| \| \| `static [Entity](entity)` \| `[ograve](#ograve)` \| \| \| `static [Entity](entity)` \| `[ordf](#ordf)` \| \| \| `static [Entity](entity)` \| `[ordm](#ordm)` \| \| \| `static [Entity](entity)` \| `[oslash](#oslash)` \| \| \| `static [Entity](entity)` \| `[otilde](#otilde)` \| \| \| `static [Entity](entity)` \| `[ouml](#ouml)` \| \| \| `static [Entity](entity)` \| `[para](#para)` \| \| \| `static [Entity](entity)` \| `[permil](#permil)` \| \| \| `static [Entity](entity)` \| `[plusmn](#plusmn)` \| \| \| `static [Entity](entity)` \| `[pound](#pound)` \| \| \| `static [Entity](entity)` \| `[quot](#quot)` \| \| \| `static [Entity](entity)` \| `[raquo](#raquo)` \| \| \| `static [Entity](entity)` \| `[rdquo](#rdquo)` \| \| \| `static [Entity](entity)` \| `[reg](#reg)` \| \| \| `static [Entity](entity)` \| `[rlm](#rlm)` \| \| \| `static [Entity](entity)` \| `[rsaquo](#rsaquo)` \| \| \| `static [Entity](entity)` \| `[rsquo](#rsquo)` \| \| \| `static [Entity](entity)` \| `[sbquo](#sbquo)` \| \| \| `static [Entity](entity)` \| `[scaron](#scaron)` \| \| \| `static [Entity](entity)` \| `[sect](#sect)` \| \| \| `static [Entity](entity)` \| `[shy](#shy)` \| \| \| `static [Entity](entity)` \| `[sup1](#sup1)` \| \| \| `static [Entity](entity)` \| `[sup2](#sup2)` \| \| \| `static [Entity](entity)` \| `[sup3](#sup3)` \| \| \| `static [Entity](entity)` \| `[szlig](#szlig)` \| \| \| `static [Entity](entity)` \| `[thinsp](#thinsp)` \| \| \| `static [Entity](entity)` \| `[thorn](#thorn)` \| \| \| `static [Entity](entity)` \| `[tilde](#tilde)` \| \| \| `static [Entity](entity)` \| `[times](#times)` \| \| \| `static [Entity](entity)` \| `[uacute](#uacute)` \| \| \| `static [Entity](entity)` \| `[ucirc](#ucirc)` \| \| \| `static [Entity](entity)` \| `[ugrave](#ugrave)` \| \| \| `static [Entity](entity)` \| `[uml](#uml)` \| \| \| `static [Entity](entity)` \| `[uuml](#uuml)` \| \| \| `static [Entity](entity)` \| `[yacute](#yacute)` \| \| \| `static [Entity](entity)` \| `[yen](#yen)` \| \| \| `static [Entity](entity)` \| `[yuml](#yuml)` \| \| \| `static [Entity](entity)` \| `[zwj](#zwj)` \| \| \| `static [Entity](entity)` \| `[zwnj](#zwnj)` \| \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[Entity](#Entity(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name)` \| \| `[Entity](#Entity(int))(int name)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `void` \| `[build](#build(groovy.lang.GroovyObject))([GroovyObject](../lang/groovyobject) builder)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Field Detail ------------ ### public static final [Entity](entity) AElig ### public static final [Entity](entity) Aacute ### public static final [Entity](entity) Acirc ### public static final [Entity](entity) Agrave ### public static final [Entity](entity) Aring ### public static final [Entity](entity) Atilde ### public static final [Entity](entity) Auml ### public static final [Entity](entity) Ccedil ### public static final [Entity](entity) Dagger ### public static final [Entity](entity) ETH ### public static final [Entity](entity) Eacute ### public static final [Entity](entity) Ecirc ### public static final [Entity](entity) Egrave ### public static final [Entity](entity) Euml ### public static final [Entity](entity) Iacute ### public static final [Entity](entity) Icirc ### public static final [Entity](entity) Igrave ### public static final [Entity](entity) Iuml ### public static final [Entity](entity) Ntilde ### public static final [Entity](entity) OElig ### public static final [Entity](entity) Oacute ### public static final [Entity](entity) Ocirc ### public static final [Entity](entity) Ograve ### public static final [Entity](entity) Oslash ### public static final [Entity](entity) Otilde ### public static final [Entity](entity) Ouml ### public static final [Entity](entity) Scaron ### public static final [Entity](entity) THORN ### public static final [Entity](entity) Uacute ### public static final [Entity](entity) Ucirc ### public static final [Entity](entity) Ugrave ### public static final [Entity](entity) Uuml ### public static final [Entity](entity) Yacute ### public static final [Entity](entity) Yuml ### public static final [Entity](entity) aacute ### public static final [Entity](entity) acirc ### public static final [Entity](entity) acute ### public static final [Entity](entity) aelig ### public static final [Entity](entity) agrave ### public static final [Entity](entity) amp ### public static final [Entity](entity) apos ### public static final [Entity](entity) aring ### public static final [Entity](entity) atilde ### public static final [Entity](entity) auml ### public static final [Entity](entity) bdquo ### public static final [Entity](entity) brvbar ### public static final [Entity](entity) ccedil ### public static final [Entity](entity) cedil ### public static final [Entity](entity) cent ### public static final [Entity](entity) circ ### public static final [Entity](entity) copy ### public static final [Entity](entity) curren ### public static final [Entity](entity) dagger ### public static final [Entity](entity) deg ### public static final [Entity](entity) divide ### public static final [Entity](entity) eacute ### public static final [Entity](entity) ecirc ### public static final [Entity](entity) egrave ### public static final [Entity](entity) emsp ### public static final [Entity](entity) ensp ### public static final [Entity](entity) eth ### public static final [Entity](entity) euml ### public static final [Entity](entity) euro ### public static final [Entity](entity) frac12 ### public static final [Entity](entity) frac14 ### public static final [Entity](entity) frac34 ### public static final [Entity](entity) gt ### public static final [Entity](entity) iacute ### public static final [Entity](entity) icirc ### public static final [Entity](entity) iexcl ### public static final [Entity](entity) igrave ### public static final [Entity](entity) iquest ### public static final [Entity](entity) iuml ### public static final [Entity](entity) laquo ### public static final [Entity](entity) ldquo ### public static final [Entity](entity) lrm ### public static final [Entity](entity) lsaquo ### public static final [Entity](entity) lsquo ### public static final [Entity](entity) lt ### public static final [Entity](entity) macr ### public static final [Entity](entity) mdash ### public static final [Entity](entity) micro ### public static final [Entity](entity) middot ### public static final [Entity](entity) nbsp ### public static final [Entity](entity) ndash ### public static final [Entity](entity) not ### public static final [Entity](entity) ntilde ### public static final [Entity](entity) oacute ### public static final [Entity](entity) ocirc ### public static final [Entity](entity) oelig ### public static final [Entity](entity) ograve ### public static final [Entity](entity) ordf ### public static final [Entity](entity) ordm ### public static final [Entity](entity) oslash ### public static final [Entity](entity) otilde ### public static final [Entity](entity) ouml ### public static final [Entity](entity) para ### public static final [Entity](entity) permil ### public static final [Entity](entity) plusmn ### public static final [Entity](entity) pound ### public static final [Entity](entity) quot ### public static final [Entity](entity) raquo ### public static final [Entity](entity) rdquo ### public static final [Entity](entity) reg ### public static final [Entity](entity) rlm ### public static final [Entity](entity) rsaquo ### public static final [Entity](entity) rsquo ### public static final [Entity](entity) sbquo ### public static final [Entity](entity) scaron ### public static final [Entity](entity) sect ### public static final [Entity](entity) shy ### public static final [Entity](entity) sup1 ### public static final [Entity](entity) sup2 ### public static final [Entity](entity) sup3 ### public static final [Entity](entity) szlig ### public static final [Entity](entity) thinsp ### public static final [Entity](entity) thorn ### public static final [Entity](entity) tilde ### public static final [Entity](entity) times ### public static final [Entity](entity) uacute ### public static final [Entity](entity) ucirc ### public static final [Entity](entity) ugrave ### public static final [Entity](entity) uml ### public static final [Entity](entity) uuml ### public static final [Entity](entity) yacute ### public static final [Entity](entity) yen ### public static final [Entity](entity) yuml ### public static final [Entity](entity) zwj ### public static final [Entity](entity) zwnj Constructor Detail ------------------ ### Entity([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name) ### Entity(int name) Method Detail ------------- ### void build([GroovyObject](../lang/groovyobject) builder) groovy [Java] Enum MarkupBuilder.CharFilter [Java] Enum MarkupBuilder.CharFilter ==================================== * groovy.xml.MarkupBuilder.CharFilter ``` public enum MarkupBuilder.CharFilter ``` Enum Constants Summary ---------------------- Enum constants classes \| Enum constant \| Description \| \| `[NONE](#NONE)` \| \| \| `[XML\_ALL](#XML_ALL)` \| \| \| `[XML\_STRICT](#XML_STRICT)` \| \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Enum Constant Detail -------------------- ### public [MarkupBuilder.CharFilter](markupbuilder.charfilter) NONE ### public [MarkupBuilder.CharFilter](markupbuilder.charfilter) XML\_ALL ### public [MarkupBuilder.CharFilter](markupbuilder.charfilter) XML\_STRICT groovy [Java] Class MarkupBuilder [Java] Class MarkupBuilder ========================== * groovy.xml.MarkupBuilder ``` public class MarkupBuilder extends [BuilderSupport](../util/buildersupport) ``` A helper class for creating XML or HTML markup. The builder supports various 'pretty printed' formats. Example: ``` new MarkupBuilder().root { a( a1:'one' ) { b { mkp.yield( '3 < 5' ) } c( a2:'two', 'blah' ) } } ``` Will print the following to System.out: ``` <root> <a a1='one'> <b>3 < 5</b> <c a2='two'>blah</c> </a> </root> ``` Notes: * `mkp` is a special namespace used to escape away from the normal building mode of the builder and get access to helper markup methods such as 'yield' and 'yieldUnescaped'. See the javadoc for [getMkp()](#getMkp()) for further details. * Note that tab, newline and carriage return characters are escaped within attributes, i.e. will become , and respectively Nested Class Summary -------------------- Nested classes \| Modifiers \| Name \| Description \| \| `enum` \| `[MarkupBuilder.CharFilter](markupbuilder.charfilter)` \| \| \| `static class` \| `[MarkupBuilder.DefaultXmlEscapingFunction](markupbuilder.defaultxmlescapingfunction)` \| \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[MarkupBuilder](#MarkupBuilder())()`Prints markup to System.out \| \| `[MarkupBuilder](#MarkupBuilder(java.io.PrintWriter))([PrintWriter](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html "PrintWriter") pw)`Sends markup to the given PrintWriter \| \| `[MarkupBuilder](#MarkupBuilder(java.io.Writer))([Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") writer)`Sends markup to the given Writer but first wrapping it in a PrintWriter \| \| `[MarkupBuilder](#MarkupBuilder(groovy.util.IndentPrinter))([IndentPrinter](../util/indentprinter) out)`Sends markup to the given IndentPrinter. \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[createNode](#createNode(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name)` \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[createNode](#createNode(java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[createNode](#createNode(java.lang.Object,%20java.util.Map,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[createNode](#createNode(java.lang.Object,%20java.util.Map))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)` \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<[Character](https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html "Character"), [Optional](https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html "Optional")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>>>` \| `[getAdditionalFilters](#getAdditionalFilters())()` \| \| \| `public boolean` \| `[getDoubleQuotes](#getDoubleQuotes())()`Returns `true` if attribute values are output with double quotes; `false` if single quotes are used. \| \| \| `public [MarkupBuilderHelper](markupbuilderhelper)` \| `[getMkp](#getMkp())()`Property that may be called from within your builder closure to access helper methods, namely [MarkupBuilderHelper.yield](markupbuilderhelper#yield(java.lang.String) "MarkupBuilderHelper.yield"), [MarkupBuilderHelper.yieldUnescaped](markupbuilderhelper#yieldUnescaped(java.lang.String) "MarkupBuilderHelper.yieldUnescaped"), [MarkupBuilderHelper.pi](markupbuilderhelper#pi(java.util.Map) "MarkupBuilderHelper.pi"), [MarkupBuilderHelper.xmlDeclaration](markupbuilderhelper#xmlDeclaration(java.util.Map) "MarkupBuilderHelper.xmlDeclaration") and [MarkupBuilderHelper.comment](markupbuilderhelper#comment(java.lang.String) "MarkupBuilderHelper.comment"). \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getName](#getName(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName)` \| \| \| `protected [IndentPrinter](../util/indentprinter)` \| `[getPrinter](#getPrinter())()` \| \| \| `public boolean` \| `[isEscapeAttributes](#isEscapeAttributes())()`Returns the escapeAttributes property value. \| \| \| `public boolean` \| `[isExpandEmptyElements](#isExpandEmptyElements())()`Whether empty elements are expanded from <tagName/> to <tagName></tagName>. \| \| \| `public boolean` \| `[isOmitEmptyAttributes](#isOmitEmptyAttributes())()`Determine whether empty attributes will appear in the produced markup. \| \| \| `public boolean` \| `[isOmitNullAttributes](#isOmitNullAttributes())()`Determine whether null attributes will appear in the produced markup. \| \| \| `protected void` \| `[nodeCompleted](#nodeCompleted(java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node)` \| \| \| `protected void` \| `[print](#print(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node)` \| \| \| `public void` \| `[setAdditionalFilters](#setAdditionalFilters(List))([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<[Character](https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html "Character"), [Optional](https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html "Optional")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>>> additionalFilters)` \| \| \| `public void` \| `[setDoubleQuotes](#setDoubleQuotes(boolean))(boolean useDoubleQuotes)`Sets whether the builder outputs attribute values in double quotes or single quotes. \| \| \| `public void` \| `[setEscapeAttributes](#setEscapeAttributes(boolean))(boolean escapeAttributes)`Defaults to true. If set to false then you must escape any special characters within attribute values such as '&', '<', CR/LF, single and double quotes etc. manually as needed. \| \| \| `public void` \| `[setExpandEmptyElements](#setExpandEmptyElements(boolean))(boolean expandEmptyElements)`Whether empty elements are expanded from <tagName/> to <tagName></tagName>. \| \| \| `public void` \| `[setOmitEmptyAttributes](#setOmitEmptyAttributes(boolean))(boolean omitEmptyAttributes)`Allows empty attributes to be removed from the generated markup. \| \| \| `public void` \| `[setOmitNullAttributes](#setOmitNullAttributes(boolean))(boolean omitNullAttributes)`Allows null attributes to be removed from the generated markup. \| \| \| `protected void` \| `[setParent](#setParent(java.lang.Object,%20java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [BuilderSupport](../util/buildersupport)` \| `[createNode](../util/buildersupport#createNode(java.lang.Object)), [createNode](../util/buildersupport#createNode(java.lang.Object,%20java.lang.Object)), [createNode](../util/buildersupport#createNode(java.lang.Object,%20java.util.Map)), [createNode](../util/buildersupport#createNode(java.lang.Object,%20java.util.Map,%20java.lang.Object)), [doInvokeMethod](../util/buildersupport#doInvokeMethod(java.lang.String,%20java.lang.Object,%20java.lang.Object)), [getCurrent](../util/buildersupport#getCurrent()), [getName](../util/buildersupport#getName(java.lang.String)), [invokeMethod](../util/buildersupport#invokeMethod(java.lang.String)), [invokeMethod](../util/buildersupport#invokeMethod(java.lang.String,%20java.lang.Object)), [nodeCompleted](../util/buildersupport#nodeCompleted(java.lang.Object,%20java.lang.Object)), [postNodeCompletion](../util/buildersupport#postNodeCompletion(java.lang.Object,%20java.lang.Object)), [setClosureDelegate](../util/buildersupport#setClosureDelegate(groovy.lang.Closure,%20java.lang.Object)), [setCurrent](../util/buildersupport#setCurrent(java.lang.Object)), [setParent](../util/buildersupport#setParent(java.lang.Object,%20java.lang.Object))` \| \| `class [GroovyObjectSupport](../lang/groovyobjectsupport)` \| `[getMetaClass](../lang/groovyobjectsupport#getMetaClass()), [setMetaClass](../lang/groovyobjectsupport#setMetaClass(groovy.lang.MetaClass))` \| Constructor Detail ------------------ ### public MarkupBuilder() Prints markup to System.out See Also: [IndentPrinter.IndentPrinter](../util/indentprinter#IndentPrinter() "IndentPrinter.IndentPrinter") ### public MarkupBuilder([PrintWriter](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html "PrintWriter") pw) Sends markup to the given PrintWriter Parameters: `pw` - the PrintWriter to use See Also: [IndentPrinter.IndentPrinter](../util/indentprinter#IndentPrinter(java.io.Writer) "IndentPrinter.IndentPrinter") ### public MarkupBuilder([Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") writer) Sends markup to the given Writer but first wrapping it in a PrintWriter Parameters: `writer` - the writer to use See Also: [IndentPrinter.IndentPrinter](../util/indentprinter#IndentPrinter(java.io.Writer) "IndentPrinter.IndentPrinter") ### public MarkupBuilder([IndentPrinter](../util/indentprinter) out) Sends markup to the given IndentPrinter. Use this option if you want to customize the indent used or provide your own IndentPrinter. Parameters: `out` - the IndentPrinter to use Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") createNode([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") createNode([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") createNode([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") createNode([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) ### public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<[Character](https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html "Character"), [Optional](https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html "Optional")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>>> getAdditionalFilters() ### public boolean getDoubleQuotes() Returns `true` if attribute values are output with double quotes; `false` if single quotes are used. By default, single quotes are used. Returns: true if double quotes are used for attributes ### public [MarkupBuilderHelper](markupbuilderhelper) getMkp() Property that may be called from within your builder closure to access helper methods, namely [MarkupBuilderHelper.yield](markupbuilderhelper#yield(java.lang.String) "MarkupBuilderHelper.yield"), [MarkupBuilderHelper.yieldUnescaped](markupbuilderhelper#yieldUnescaped(java.lang.String) "MarkupBuilderHelper.yieldUnescaped"), [MarkupBuilderHelper.pi](markupbuilderhelper#pi(java.util.Map) "MarkupBuilderHelper.pi"), [MarkupBuilderHelper.xmlDeclaration](markupbuilderhelper#xmlDeclaration(java.util.Map) "MarkupBuilderHelper.xmlDeclaration") and [MarkupBuilderHelper.comment](markupbuilderhelper#comment(java.lang.String) "MarkupBuilderHelper.comment"). Returns: this MarkupBuilder ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getName([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") methodName) ### protected [IndentPrinter](../util/indentprinter) getPrinter() ### public boolean isEscapeAttributes() Returns the escapeAttributes property value. Returns: the escapeAttributes property value See Also: [setEscapeAttributes(boolean)](#setEscapeAttributes(boolean)) ### public boolean isExpandEmptyElements() Whether empty elements are expanded from <tagName/> to <tagName></tagName>. Returns: `true`, if empty elements will be represented by an opening tag followed immediately by a closing tag. ### public boolean isOmitEmptyAttributes() Determine whether empty attributes will appear in the produced markup. Returns: `true`, if empty attributes will be removed from the resulting markup. ### public boolean isOmitNullAttributes() Determine whether null attributes will appear in the produced markup. Returns: `true`, if null attributes will be removed from the resulting markup. ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected void nodeCompleted([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node) ### protected void print([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") node) ### public void setAdditionalFilters([List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")<[Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function")<[Character](https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html "Character"), [Optional](https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html "Optional")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>>> additionalFilters) ### public void setDoubleQuotes(boolean useDoubleQuotes) Sets whether the builder outputs attribute values in double quotes or single quotes. Parameters: `useDoubleQuotes` - If this parameter is `true`, double quotes are used; otherwise, single quotes are. ### public void setEscapeAttributes(boolean escapeAttributes) Defaults to true. If set to false then you must escape any special characters within attribute values such as '&', '<', CR/LF, single and double quotes etc. manually as needed. The builder will not guard against producing invalid XML when in this mode and the output may not be able to be parsed/round-tripped but it does give you full control when producing for instance HTML output. Parameters: `escapeAttributes` - the new value ### public void setExpandEmptyElements(boolean expandEmptyElements) Whether empty elements are expanded from <tagName/> to <tagName></tagName>. Parameters: `expandEmptyElements` - if `true`, empty elements will be represented by an opening tag followed immediately by a closing tag. Defaults to `false`. ### public void setOmitEmptyAttributes(boolean omitEmptyAttributes) Allows empty attributes to be removed from the generated markup. Parameters: `omitEmptyAttributes` - if `true`, empty attributes will not be included in the resulting markup. Defaults to `false`. ### public void setOmitNullAttributes(boolean omitNullAttributes) Allows null attributes to be removed from the generated markup. Parameters: `omitNullAttributes` - if `true`, null attributes will not be included in the resulting markup. If `false` null attributes will be included in the markup as empty strings regardless of the omitEmptyAttribute setting. Defaults to `false`. ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected void setParent([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") child)	programming_docs
groovy [Groovy] Class XmlSlurperFactory [Groovy] Class XmlSlurperFactory ================================ * groovy.xml.XmlSlurperFactory ``` class XmlSlurperFactory extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Factory method targetting dynamic contexts which allows a new `XmlSlurper` to be created. It is intended to assist with migration from Groovy 2.5.x to Groovy 3+. Code using this factory will not need to change moving from 2.x to 3+. In Groovy 2.5.x, a `groovy.util.XmlSlurper` will be returned. For Groovy 3+, a `groovy.xml.XmlSlurper` will be returned. For contexts requiring additional static type checking, it is recommended simply to use the normal constructor and change the package to `groovy.xml` prior to reaching Groovy 4. Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[XmlSlurperFactory](#XmlSlurperFactory())()` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[newSlurper](#newSlurper(java.lang.Object))([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] args)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### XmlSlurperFactory() Method Detail ------------- ### static [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") newSlurper([Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")[] args) groovy [Java] Class XmlParser [Java] Class XmlParser ====================== * groovy.xml.XmlParser All Implemented Interfaces and Traits: [ContentHandler](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/ContentHandler.html "ContentHandler") ``` public class XmlParser extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") implements [ContentHandler](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/ContentHandler.html "ContentHandler") ``` A helper class for parsing XML into a tree of Node instances for a simple way of processing XML. This parser does not preserve the XML InfoSet - if that's what you need try using W3C DOM, dom4j, JDOM, XOM etc. This parser ignores comments and processing instructions and converts the XML into a Node for each element in the XML with attributes and child Nodes and Strings. This simple model is sufficient for most simple use cases of processing XML. Example usage: ``` import groovy.xml.XmlParser def xml = '<root><one a1="uno!"/><two>Some text!</two></root>' def rootNode = new XmlParser().parseText(xml) assert rootNode.name() == 'root' assert rootNode.one[0].@a1 == 'uno!' assert rootNode.two.text() == 'Some text!' rootNode.children().each { assert it.name() in ['one','two'] } ``` Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[XmlParser](#XmlParser())()`Creates a non-validating and namespace-aware `XmlParser` which does not allow DOCTYPE declarations in documents. \| \| `[XmlParser](#XmlParser(boolean,%20boolean))(boolean validating, boolean namespaceAware)`Creates a `XmlParser` which does not allow DOCTYPE declarations in documents. \| \| `[XmlParser](#XmlParser(boolean,%20boolean,%20boolean))(boolean validating, boolean namespaceAware, boolean allowDocTypeDeclaration)`Creates a `XmlParser`. \| \| `[XmlParser](#XmlParser(org.xml.sax.XMLReader))([XMLReader](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/XMLReader.html "XMLReader") reader)` \| \| `[XmlParser](#XmlParser(javax.xml.parsers.SAXParser))([SAXParser](https://docs.oracle.com/javase/8/docs/api/javax/xml/parsers/SAXParser.html "SAXParser") parser)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `protected void` \| `[addTextToNode](#addTextToNode())()` \| \| \| `public void` \| `[characters](#characters(char%5B%5D,%20int,%20int))(char[] buffer, int start, int length)` \| \| \| `protected [Node](../util/node)` \| `[createNode](#createNode(groovy.util.Node,%20java.lang.Object,%20java.util.Map))([Node](../util/node) parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes)`Creates a new node with the given parent, name, and attributes. \| \| \| `public void` \| `[endDocument](#endDocument())()` \| \| \| `public void` \| `[endElement](#endElement(java.lang.String,%20java.lang.String,%20java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") namespaceURI, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") localName, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") qName)` \| \| \| `public void` \| `[endPrefixMapping](#endPrefixMapping(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") prefix)` \| \| \| `public [DTDHandler](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/DTDHandler.html "DTDHandler")` \| `[getDTDHandler](#getDTDHandler())()` \| \| \| `public [Locator](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/Locator.html "Locator")` \| `[getDocumentLocator](#getDocumentLocator())()` \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getElementName](#getElementName(java.lang.String,%20java.lang.String,%20java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") namespaceURI, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") localName, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") qName)`Return a name given the namespaceURI, localName and qName. \| \| \| `public [EntityResolver](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/EntityResolver.html "EntityResolver")` \| `[getEntityResolver](#getEntityResolver())()` \| \| \| `public [ErrorHandler](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/ErrorHandler.html "ErrorHandler")` \| `[getErrorHandler](#getErrorHandler())()` \| \| \| `public boolean` \| `[getFeature](#getFeature(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri)` \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getProperty](#getProperty(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri)` \| \| \| `protected [XMLReader](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/XMLReader.html "XMLReader")` \| `[getXMLReader](#getXMLReader())()` \| \| \| `public void` \| `[ignorableWhitespace](#ignorableWhitespace(char%5B%5D,%20int,%20int))(char[] buffer, int start, int len)` \| \| \| `public boolean` \| `[isKeepIgnorableWhitespace](#isKeepIgnorableWhitespace())()`Returns the current keep ignorable whitespace setting. \| \| \| `public boolean` \| `[isNamespaceAware](#isNamespaceAware())()`Determine if namespace handling is enabled. \| \| \| `public boolean` \| `[isTrimWhitespace](#isTrimWhitespace())()`Returns the current trim whitespace setting. \| \| \| `public [Node](../util/node)` \| `[parse](#parse(java.io.File))([File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File") file)`Parses the content of the given file as XML turning it into a tree of Nodes. \| \| \| `public [Node](../util/node)` \| `[parse](#parse(org.xml.sax.InputSource))([InputSource](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/InputSource.html "InputSource") input)`Parse the content of the specified input source into a tree of Nodes. \| \| \| `public [Node](../util/node)` \| `[parse](#parse(java.io.InputStream))([InputStream](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html "InputStream") input)`Parse the content of the specified input stream into a tree of Nodes. \| \| \| `public [Node](../util/node)` \| `[parse](#parse(java.io.Reader))([Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") in)`Parse the content of the specified reader into a tree of Nodes. \| \| \| `public [Node](../util/node)` \| `[parse](#parse(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri)`Parse the content of the specified URI into a tree of Nodes. \| \| \| `public [Node](../util/node)` \| `[parseText](#parseText(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text)`A helper method to parse the given text as XML. \| \| \| `public void` \| `[processingInstruction](#processingInstruction(java.lang.String,%20java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") target, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") data)` \| \| \| `public void` \| `[setDTDHandler](#setDTDHandler(org.xml.sax.DTDHandler))([DTDHandler](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/DTDHandler.html "DTDHandler") dtdHandler)` \| \| \| `public void` \| `[setDocumentLocator](#setDocumentLocator(org.xml.sax.Locator))([Locator](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/Locator.html "Locator") locator)` \| \| \| `public void` \| `[setEntityResolver](#setEntityResolver(org.xml.sax.EntityResolver))([EntityResolver](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/EntityResolver.html "EntityResolver") entityResolver)` \| \| \| `public void` \| `[setErrorHandler](#setErrorHandler(org.xml.sax.ErrorHandler))([ErrorHandler](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/ErrorHandler.html "ErrorHandler") errorHandler)` \| \| \| `public void` \| `[setFeature](#setFeature(java.lang.String,%20boolean))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri, boolean value)` \| \| \| `public void` \| `[setKeepIgnorableWhitespace](#setKeepIgnorableWhitespace(boolean))(boolean keepIgnorableWhitespace)`Sets the keep ignorable whitespace setting value. \| \| \| `public void` \| `[setNamespaceAware](#setNamespaceAware(boolean))(boolean namespaceAware)`Enable and/or disable namespace handling. \| \| \| `public void` \| `[setProperty](#setProperty(java.lang.String,%20java.lang.Object))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value)` \| \| \| `public void` \| `[setTrimWhitespace](#setTrimWhitespace(boolean))(boolean trimWhitespace)`Sets the trim whitespace setting value. \| \| \| `public void` \| `[skippedEntity](#skippedEntity(java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name)` \| \| \| `public void` \| `[startDocument](#startDocument())()` \| \| \| `public void` \| `[startElement](#startElement(java.lang.String,%20java.lang.String,%20java.lang.String,%20org.xml.sax.Attributes))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") namespaceURI, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") localName, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") qName, [Attributes](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/Attributes.html "Attributes") list)` \| \| \| `public void` \| `[startPrefixMapping](#startPrefixMapping(java.lang.String,%20java.lang.String))([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") prefix, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") namespaceURI)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Constructor Detail ------------------ ### public XmlParser() Creates a non-validating and namespace-aware `XmlParser` which does not allow DOCTYPE declarations in documents. throws: ParserConfigurationException if no parser which satisfies the requested configuration can be created. throws: SAXException for SAX errors. ### public XmlParser(boolean validating, boolean namespaceAware) Creates a `XmlParser` which does not allow DOCTYPE declarations in documents. throws: ParserConfigurationException if no parser which satisfies the requested configuration can be created. throws: SAXException for SAX errors. Parameters: `validating` - `true` if the parser should validate documents as they are parsed; false otherwise. `namespaceAware` - `true` if the parser should provide support for XML namespaces; `false` otherwise. ### public XmlParser(boolean validating, boolean namespaceAware, boolean allowDocTypeDeclaration) Creates a `XmlParser`. throws: ParserConfigurationException if no parser which satisfies the requested configuration can be created. throws: SAXException for SAX errors. Parameters: `validating` - `true` if the parser should validate documents as they are parsed; false otherwise. `namespaceAware` - `true` if the parser should provide support for XML namespaces; `false` otherwise. `allowDocTypeDeclaration` - `true` if the parser should provide support for DOCTYPE declarations; `false` otherwise. ### public XmlParser([XMLReader](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/XMLReader.html "XMLReader") reader) ### public XmlParser([SAXParser](https://docs.oracle.com/javase/8/docs/api/javax/xml/parsers/SAXParser.html "SAXParser") parser) Method Detail ------------- ### protected void addTextToNode() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void characters(char[] buffer, int start, int length) ### protected [Node](../util/node) createNode([Node](../util/node) parent, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") attributes) Creates a new node with the given parent, name, and attributes. The default implementation returns an instance of `groovy.util.Node`. Parameters: `parent` - the parent node, or null if the node being created is the root node `name` - an Object representing the name of the node (typically an instance of [QName](../namespace/qname "QName")) `attributes` - a Map of attribute names to attribute values Returns: a new Node instance representing the current node ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void endDocument() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void endElement([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") namespaceURI, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") localName, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") qName) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void endPrefixMapping([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") prefix) ### public [DTDHandler](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/DTDHandler.html "DTDHandler") getDTDHandler() ### public [Locator](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/Locator.html "Locator") getDocumentLocator() ### protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getElementName([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") namespaceURI, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") localName, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") qName) Return a name given the namespaceURI, localName and qName. Parameters: `namespaceURI` - the namespace URI `localName` - the local name `qName` - the qualified name Returns: the newly created representation of the name ### public [EntityResolver](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/EntityResolver.html "EntityResolver") getEntityResolver() ### public [ErrorHandler](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/ErrorHandler.html "ErrorHandler") getErrorHandler() ### public boolean getFeature([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri) ### public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getProperty([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri) ### protected [XMLReader](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/XMLReader.html "XMLReader") getXMLReader() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void ignorableWhitespace(char[] buffer, int start, int len) ### public boolean isKeepIgnorableWhitespace() Returns the current keep ignorable whitespace setting. Returns: true if ignorable whitespace will be kept (default false) ### public boolean isNamespaceAware() Determine if namespace handling is enabled. Returns: true if namespace handling is enabled ### public boolean isTrimWhitespace() Returns the current trim whitespace setting. Returns: true if whitespace will be trimmed ### public [Node](../util/node) parse([File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html "File") file) Parses the content of the given file as XML turning it into a tree of Nodes. throws: SAXException Any SAX exception, possibly wrapping another exception. throws: IOException An IO exception from the parser, possibly from a byte stream or character stream supplied by the application. Parameters: `file` - the File containing the XML to be parsed Returns: the root node of the parsed tree of Nodes ### public [Node](../util/node) parse([InputSource](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/InputSource.html "InputSource") input) Parse the content of the specified input source into a tree of Nodes. throws: SAXException Any SAX exception, possibly wrapping another exception. throws: IOException An IO exception from the parser, possibly from a byte stream or character stream supplied by the application. Parameters: `input` - the InputSource for the XML to parse Returns: the root node of the parsed tree of Nodes ### public [Node](../util/node) parse([InputStream](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html "InputStream") input) Parse the content of the specified input stream into a tree of Nodes. Note that using this method will not provide the parser with any URI for which to find DTDs etc throws: SAXException Any SAX exception, possibly wrapping another exception. throws: IOException An IO exception from the parser, possibly from a byte stream or character stream supplied by the application. Parameters: `input` - an InputStream containing the XML to be parsed Returns: the root node of the parsed tree of Nodes ### public [Node](../util/node) parse([Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html "Reader") in) Parse the content of the specified reader into a tree of Nodes. Note that using this method will not provide the parser with any URI for which to find DTDs etc throws: SAXException Any SAX exception, possibly wrapping another exception. throws: IOException An IO exception from the parser, possibly from a byte stream or character stream supplied by the application. Parameters: `in` - a Reader to read the XML to be parsed Returns: the root node of the parsed tree of Nodes ### public [Node](../util/node) parse([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri) Parse the content of the specified URI into a tree of Nodes. throws: SAXException Any SAX exception, possibly wrapping another exception. throws: IOException An IO exception from the parser, possibly from a byte stream or character stream supplied by the application. Parameters: `uri` - a String containing a uri pointing to the XML to be parsed Returns: the root node of the parsed tree of Nodes ### public [Node](../util/node) parseText([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text) A helper method to parse the given text as XML. throws: SAXException Any SAX exception, possibly wrapping another exception. throws: IOException An IO exception from the parser, possibly from a byte stream or character stream supplied by the application. Parameters: `text` - the XML text to parse Returns: the root node of the parsed tree of Nodes ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void processingInstruction([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") target, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") data) ### public void setDTDHandler([DTDHandler](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/DTDHandler.html "DTDHandler") dtdHandler) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void setDocumentLocator([Locator](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/Locator.html "Locator") locator) ### public void setEntityResolver([EntityResolver](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/EntityResolver.html "EntityResolver") entityResolver) ### public void setErrorHandler([ErrorHandler](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/ErrorHandler.html "ErrorHandler") errorHandler) ### public void setFeature([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri, boolean value) ### public void setKeepIgnorableWhitespace(boolean keepIgnorableWhitespace) Sets the keep ignorable whitespace setting value. Parameters: `keepIgnorableWhitespace` - the desired new value ### public void setNamespaceAware(boolean namespaceAware) Enable and/or disable namespace handling. Parameters: `namespaceAware` - the new desired value ### public void setProperty([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") uri, [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") value) ### public void setTrimWhitespace(boolean trimWhitespace) Sets the trim whitespace setting value. Parameters: `trimWhitespace` - the desired setting value ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void skippedEntity([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void startDocument() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void startElement([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") namespaceURI, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") localName, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") qName, [Attributes](https://docs.oracle.com/javase/8/docs/api/org/xml/sax/Attributes.html "Attributes") list) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void startPrefixMapping([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") prefix, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") namespaceURI)	programming_docs
groovy [Java] Class StandardXmlAttributeFilter [Java] Class StandardXmlAttributeFilter ======================================= * groovy.xml.markupsupport.StandardXmlAttributeFilter All Implemented Interfaces and Traits: [Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function") ``` public class StandardXmlAttributeFilter extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") implements [Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function") ``` Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [Optional](https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html "Optional")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>` \| `[apply](#apply(java.lang.Character))([Character](https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html "Character") ch)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Optional](https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html "Optional")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> apply([Character](https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html "Character") ch) groovy [Java] Class SurrogateToUndefined [Java] Class SurrogateToUndefined ================================= * groovy.xml.markupsupport.SurrogateToUndefined All Implemented Interfaces and Traits: [Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function") ``` public class SurrogateToUndefined extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") implements [Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function") ``` Convert surrogate chars to XML undefined character. Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [Optional](https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html "Optional")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>` \| `[apply](#apply(java.lang.Character))([Character](https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html "Character") ch)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Optional](https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html "Optional")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> apply([Character](https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html "Character") ch) groovy [Java] Class AllControlToUndefined [Java] Class AllControlToUndefined ================================== * groovy.xml.markupsupport.AllControlToUndefined ``` public class AllControlToUndefined extends [StandardControlToUndefined](standardcontroltoundefined) ``` Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [Optional](https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html "Optional")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>` \| `[apply](#apply(java.lang.Character))([Character](https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html "Character") ch)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [StandardControlToUndefined](standardcontroltoundefined)` \| `[apply](standardcontroltoundefined#apply(java.lang.Character))` \| Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Optional](https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html "Optional")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> apply([Character](https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html "Character") ch) groovy [Java] Class StandardXmlFilter [Java] Class StandardXmlFilter ============================== * groovy.xml.markupsupport.StandardXmlFilter All Implemented Interfaces and Traits: [Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function") ``` public class StandardXmlFilter extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") implements [Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function") ``` Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [Optional](https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html "Optional")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>` \| `[apply](#apply(java.lang.Character))([Character](https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html "Character") ch)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Optional](https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html "Optional")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> apply([Character](https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html "Character") ch) groovy [Java] Class DoubleQuoteFilter [Java] Class DoubleQuoteFilter ============================== * groovy.xml.markupsupport.DoubleQuoteFilter All Implemented Interfaces and Traits: [Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function") ``` public class DoubleQuoteFilter extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") implements [Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function") ``` Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [Optional](https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html "Optional")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>` \| `[apply](#apply(java.lang.Character))([Character](https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html "Character") ch)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Optional](https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html "Optional")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> apply([Character](https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html "Character") ch) groovy [Java] Class StandardControlToUndefined [Java] Class StandardControlToUndefined ======================================= * groovy.xml.markupsupport.StandardControlToUndefined All Implemented Interfaces and Traits: [Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function") ``` public class StandardControlToUndefined extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") implements [Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function") ``` Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [Optional](https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html "Optional")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>` \| `[apply](#apply(java.lang.Character))([Character](https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html "Character") ch)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Optional](https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html "Optional")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> apply([Character](https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html "Character") ch) groovy [Java] Class SingleQuoteFilter [Java] Class SingleQuoteFilter ============================== * groovy.xml.markupsupport.SingleQuoteFilter All Implemented Interfaces and Traits: [Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function") ``` public class SingleQuoteFilter extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") implements [Function](https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html "Function") ``` Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [Optional](https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html "Optional")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")>` \| `[apply](#apply(java.lang.Character))([Character](https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html "Character") ch)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Optional](https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html "Optional")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> apply([Character](https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html "Character") ch) groovy [Java] Class StreamingMarkupWriter [Java] Class StreamingMarkupWriter ================================== * groovy.xml.streamingmarkupsupport.StreamingMarkupWriter ``` public class StreamingMarkupWriter extends [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") ``` Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `protected [CharsetEncoder](https://docs.oracle.com/javase/8/docs/api/java/nio/charset/CharsetEncoder.html "CharsetEncoder")` \| `[encoder](#encoder)` \| \| \| `protected [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[encoding](#encoding)` \| \| \| `protected boolean` \| `[encodingKnown](#encodingKnown)` \| \| \| `protected boolean` \| `[haveHighSurrogate](#haveHighSurrogate)` \| \| \| `protected [StringBuilder](https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html "StringBuilder")` \| `[surrogatePair](#surrogatePair)` \| \| \| `protected [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer")` \| `[writer](#writer)` \| \| \| `protected boolean` \| `[writingAttribute](#writingAttribute)` \| \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[StreamingMarkupWriter](#StreamingMarkupWriter(java.io.Writer,%20java.lang.String))([Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") writer, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") encoding)` \| \| `[StreamingMarkupWriter](#StreamingMarkupWriter(java.io.Writer,%20java.lang.String,%20boolean))([Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") writer, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") encoding, boolean useDoubleQuotes)` \| \| `[StreamingMarkupWriter](#StreamingMarkupWriter(java.io.Writer))([Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") writer)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public void` \| `[close](#close())()` \| \| \| `public void` \| `[close](#close())()` \| \| \| `public [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer")` \| `[escaped](#escaped())()` \| \| \| `public [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer")` \| `[escaped](#escaped())()` \| \| \| `public void` \| `[flush](#flush())()` \| \| \| `public void` \| `[flush](#flush())()` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[getEncoding](#getEncoding())()` \| \| \| `public boolean` \| `[getEncodingKnown](#getEncodingKnown())()` \| \| \| `public void` \| `[setWritingAttribute](#setWritingAttribute(boolean))(boolean writingAttribute)` \| \| \| `public void` \| `[setWritingAttribute](#setWritingAttribute(boolean))(boolean writingAttribute)` \| \| \| `public [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer")` \| `[unescaped](#unescaped())()` \| \| \| `public [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer")` \| `[unescaped](#unescaped())()` \| \| \| `public void` \| `[write](#write(int))(int c)` \| \| \| `public void` \| `[write](#write(char%5B%5D,%20int,%20int))(char[] cbuf, int off, int len)` \| \| \| `public void` \| `[write](#write(int))(int c)` \| \| \| `public void` \| `[write](#write(char%5B%5D,%20int,%20int))(char[] cbuf, int off, int len)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer")` \| `[append](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#append(java.lang.CharSequence,%20int,%20int) "append"), [append](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#append(java.lang.CharSequence,%20int,%20int) "append"), [append](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#append(char) "append"), [append](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#append(char) "append"), [append](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#append(java.lang.CharSequence) "append"), [append](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#append(java.lang.CharSequence) "append"), [flush](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#flush() "flush"), [write](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#write(java.lang.String,%20int,%20int) "write"), [write](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#write(int) "write"), [write](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#write(java.lang.String) "write"), [write](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#write(%5BC,%20int,%20int) "write"), [write](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#write(%5BC) "write"), [close](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#close() "close"), [nullWriter](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#nullWriter() "nullWriter"), [wait](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html#notifyAll() "notifyAll")` \| Field Detail ------------ ### protected final [CharsetEncoder](https://docs.oracle.com/javase/8/docs/api/java/nio/charset/CharsetEncoder.html "CharsetEncoder") encoder ### protected final [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") encoding ### protected boolean encodingKnown ### protected boolean haveHighSurrogate ### protected [StringBuilder](https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html "StringBuilder") surrogatePair ### protected final [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") writer ### protected boolean writingAttribute Constructor Detail ------------------ ### public StreamingMarkupWriter([Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") writer, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") encoding) ### public StreamingMarkupWriter([Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") writer, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") encoding, boolean useDoubleQuotes) ### public StreamingMarkupWriter([Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") writer) Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void close() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void close() ### public [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") escaped() ### public [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") escaped() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void flush() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void flush() ### public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") getEncoding() ### public boolean getEncodingKnown() ### public void setWritingAttribute(boolean writingAttribute) ### public void setWritingAttribute(boolean writingAttribute) ### public [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") unescaped() ### public [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") unescaped() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void write(int c) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void write(char[] cbuf, int off, int len) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void write(int c) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void write(char[] cbuf, int off, int len)	programming_docs
groovy [Java] Class BaseMarkupBuilder [Java] Class BaseMarkupBuilder ============================== * groovy.xml.streamingmarkupsupport.BaseMarkupBuilder ``` public class BaseMarkupBuilder extends [Builder](builder) ``` Inherited fields \| Fields inherited from class \| Fields \| \| `class [Builder](builder)` \| `[namespaceMethodMap](builder#namespaceMethodMap)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[BaseMarkupBuilder](#BaseMarkupBuilder(java.util.Map))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") namespaceMethodMap)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[bind](#bind(groovy.lang.Closure))([Closure](../../lang/closure) root)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Builder](builder)` \| `[bind](builder#bind(groovy.lang.Closure))` \| \| `class [GroovyObjectSupport](../../lang/groovyobjectsupport)` \| `[getMetaClass](../../lang/groovyobjectsupport#getMetaClass()), [setMetaClass](../../lang/groovyobjectsupport#setMetaClass(groovy.lang.MetaClass))` \| Constructor Detail ------------------ ### public BaseMarkupBuilder([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") namespaceMethodMap) Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") bind([Closure](../../lang/closure) root) groovy [Java] Class Builder [Java] Class Builder ==================== * groovy.xml.streamingmarkupsupport.Builder ``` public abstract class Builder extends [GroovyObjectSupport](../../lang/groovyobjectsupport) ``` Nested Class Summary -------------------- Nested classes \| Modifiers \| Name \| Description \| \| `protected static class` \| `[Builder.Built](builder.built)` \| \| Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `protected [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")` \| `[namespaceMethodMap](#namespaceMethodMap)` \| \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[Builder](#Builder(java.util.Map))([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") namespaceMethodMap)` \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public abstract [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[bind](#bind(groovy.lang.Closure))([Closure](../../lang/closure) root)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [GroovyObjectSupport](../../lang/groovyobjectsupport)` \| `[getMetaClass](../../lang/groovyobjectsupport#getMetaClass()), [setMetaClass](../../lang/groovyobjectsupport#setMetaClass(groovy.lang.MetaClass))` \| Field Detail ------------ ### protected final [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") namespaceMethodMap Constructor Detail ------------------ ### public Builder([Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") namespaceMethodMap) Method Detail ------------- ### public abstract [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") bind([Closure](../../lang/closure) root) groovy [Groovy] Class AbstractStreamingBuilder [Groovy] Class AbstractStreamingBuilder ======================================= * groovy.xml.streamingmarkupsupport.AbstractStreamingBuilder ``` class AbstractStreamingBuilder extends [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") ``` Properties Summary ------------------ Properties \| Type \| Name and description \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[aliasSetupClosure](#aliasSetupClosure)` \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[badTagClosure](#badTagClosure)` \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[builder](#builder)` \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getNamespaceClosure](#getNamespaceClosure)` \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[namespaceSetupClosure](#namespaceSetupClosure)` \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[specialTags](#specialTags)` \| \| `[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[toMapStringClosure](#toMapStringClosure)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[AbstractStreamingBuilder](#AbstractStreamingBuilder())()` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,%20int) "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait() "wait"), [wait](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long) "wait"), [equals](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object) "equals"), [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString() "toString"), [hashCode](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode() "hashCode"), [getClass](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass() "getClass"), [notify](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify() "notify"), [notifyAll](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll() "notifyAll")` \| Property Detail --------------- ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") aliasSetupClosure ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") badTagClosure ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") builder ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getNamespaceClosure ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") namespaceSetupClosure ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") specialTags ### [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") toMapStringClosure Constructor Detail ------------------ ### AbstractStreamingBuilder() groovy [Java] Class Builder.Built [Java] Class Builder.Built ========================== * groovy.xml.streamingmarkupsupport.Builder.Built ``` protected static abstract class Builder.Built extends [GroovyObjectSupport](../../lang/groovyobjectsupport) ``` Field Summary ------------- Fields \| Modifiers \| Name \| Description \| \| `protected [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")` \| `[namespaceSpecificTags](#namespaceSpecificTags)` \| \| \| `protected [Closure](../../lang/closure)` \| `[root](#root)` \| \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[Built](#Built(groovy.lang.Closure,%20java.util.Map))([Closure](../../lang/closure) root, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") namespaceTagMap)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [GroovyObjectSupport](../../lang/groovyobjectsupport)` \| `[getMetaClass](../../lang/groovyobjectsupport#getMetaClass()), [setMetaClass](../../lang/groovyobjectsupport#setMetaClass(groovy.lang.MetaClass))` \| Field Detail ------------ ### protected final [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") namespaceSpecificTags ### protected final [Closure](../../lang/closure) root Constructor Detail ------------------ ### public Built([Closure](../../lang/closure) root, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map") namespaceTagMap) groovy [Java] Class Attributes [Java] Class Attributes ======================= * groovy.xml.slurpersupport.Attributes ``` public class Attributes extends [NodeChildren](nodechildren) ``` Lazy evaluated representation of a node's attributes. Inherited fields \| Fields inherited from class \| Fields \| \| `class [GPathResult](gpathresult)` \| `[name](gpathresult#name), [namespaceMap](gpathresult#namespaceMap), [namespacePrefix](gpathresult#namespacePrefix), [namespaceTagHints](gpathresult#namespaceTagHints), [parent](gpathresult#parent)` \| Constructor Summary ------------------- Constructors \| Constructor and description \| \| `[Attributes](#Attributes(groovy.xml.slurpersupport.GPathResult,%20java.lang.String,%20java.lang.String,%20Map))([GPathResult](gpathresult) parent, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") namespacePrefix, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> namespaceTagHints)` Parameters: `parent` - the GPathResult prior to the application of the expression creating this GPathResult \| \| `[Attributes](#Attributes(groovy.xml.slurpersupport.GPathResult,%20java.lang.String,%20Map))([GPathResult](gpathresult) parent, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> namespaceTagHints)` Parameters: `parent` - the GPathResult prior to the application of the expression creating this GPathResult \| Methods Summary --------------- Methods \| Type Params \| Return Type \| Name and description \| \| \| `public void` \| `[build](#build(groovy.lang.GroovyObject))([GroovyObject](../../lang/groovyobject) builder)` \| \| \| `public [Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html "Iterator")` \| `[childNodes](#childNodes())()`Throws a `GroovyRuntimeException`, because attributes can have no children. \| \| \| `public [GPathResult](gpathresult)` \| `[findAll](#findAll(groovy.lang.Closure))([Closure](../../lang/closure) closure)` \| \| \| `protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object")` \| `[getNextNode](#getNextNode(java.util.Iterator))([Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html "Iterator") iter)` \| \| \| `public [Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html "Iterator")` \| `[iterator](#iterator())()` \| \| \| `public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List")` \| `[list](#list())()` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[name](#name())()` \| \| \| `public [Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html "Iterator")` \| `[nodeIterator](#nodeIterator())()` \| \| \| `public [GPathResult](gpathresult)` \| `[parents](#parents())()` \| \| \| `public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")` \| `[text](#text())()` \| \| \| `public [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer")` \| `[writeTo](#writeTo(java.io.Writer))([Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") out)` \| Inherited Methods Summary ------------------------- Inherited Methods \| Methods inherited from class \| Name \| \| `class [NodeChildren](nodechildren)` \| `[appendNode](nodechildren#appendNode(java.lang.Object)), [build](nodechildren#build(groovy.lang.GroovyObject)), [childNodes](nodechildren#childNodes()), [find](nodechildren#find(groovy.lang.Closure)), [findAll](nodechildren#findAll(groovy.lang.Closure)), [getNextNode](nodechildren#getNextNode(java.util.Iterator)), [hasNext](nodechildren#hasNext()), [hasNext](nodechildren#hasNext()), [iterator](nodechildren#iterator()), [next](nodechildren#next()), [next](nodechildren#next()), [nodeIterator](nodechildren#nodeIterator()), [parents](nodechildren#parents()), [remove](nodechildren#remove()), [remove](nodechildren#remove()), [replaceBody](nodechildren#replaceBody(java.lang.Object)), [replaceNode](nodechildren#replaceNode(groovy.lang.Closure)), [size](nodechildren#size()), [text](nodechildren#text()), [writeTo](nodechildren#writeTo(java.io.Writer))` \| \| `class [GPathResult](gpathresult)` \| `[appendNode](gpathresult#appendNode(java.lang.Object)), [breadthFirst](gpathresult#breadthFirst()), [childNodes](gpathresult#childNodes()), [children](gpathresult#children()), [createIterator](gpathresult#createIterator(java.lang.Object)), [declareNamespace](gpathresult#declareNamespace(java.util.Map)), [depthFirst](gpathresult#depthFirst()), [doCall](gpathresult#doCall(java.lang.Object)), [doCall](gpathresult#doCall(java.lang.Object)), [equals](gpathresult#equals(java.lang.Object)), [find](gpathresult#find(groovy.lang.Closure)), [findAll](gpathresult#findAll(groovy.lang.Closure)), [getAt](gpathresult#getAt(int)), [getAt](gpathresult#getAt(groovy.lang.IntRange)), [getAttribute](gpathresult#getAttribute(java.lang.Object,%20java.lang.String)), [getBody](gpathresult#getBody()), [getProperty](gpathresult#getProperty(java.lang.String)), [hasNext](gpathresult#hasNext()), [hasNext](gpathresult#hasNext()), [hasNext](gpathresult#hasNext()), [hashCode](gpathresult#hashCode()), [isEmpty](gpathresult#isEmpty()), [iterator](gpathresult#iterator()), [leftShift](gpathresult#leftShift(java.lang.Object)), [list](gpathresult#list()), [lookupNamespace](gpathresult#lookupNamespace(java.lang.String)), [name](gpathresult#name()), [next](gpathresult#next()), [next](gpathresult#next()), [next](gpathresult#next()), [nodeIterator](gpathresult#nodeIterator()), [parent](gpathresult#parent()), [parents](gpathresult#parents()), [plus](gpathresult#plus(java.lang.Object)), [plus](gpathresult#plus(groovy.lang.Closure)), [pop](gpathresult#pop()), [putAt](gpathresult#putAt(int,%20java.lang.Object)), [remove](gpathresult#remove()), [remove](gpathresult#remove()), [remove](gpathresult#remove()), [replaceBody](gpathresult#replaceBody(java.lang.Object)), [replaceNode](gpathresult#replaceNode(groovy.lang.Closure)), [setAttribute](gpathresult#setAttribute(java.lang.Object,%20java.lang.String,%20java.lang.Object)), [setMetaClass](gpathresult#setMetaClass(groovy.lang.MetaClass)), [setProperty](gpathresult#setProperty(java.lang.String,%20java.lang.Object)), [size](gpathresult#size()), [text](gpathresult#text()), [toBigDecimal](gpathresult#toBigDecimal()), [toBigInteger](gpathresult#toBigInteger()), [toBoolean](gpathresult#toBoolean()), [toDouble](gpathresult#toDouble()), [toFloat](gpathresult#toFloat()), [toInteger](gpathresult#toInteger()), [toLong](gpathresult#toLong()), [toString](gpathresult#toString()), [toURI](gpathresult#toURI()), [toURL](gpathresult#toURL())` \| \| `class [GroovyObjectSupport](../../lang/groovyobjectsupport)` \| `[getMetaClass](../../lang/groovyobjectsupport#getMetaClass()), [setMetaClass](../../lang/groovyobjectsupport#setMetaClass(groovy.lang.MetaClass))` \| Constructor Detail ------------------ ### public Attributes([GPathResult](gpathresult) parent, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") namespacePrefix, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> namespaceTagHints) Parameters: `parent` - the GPathResult prior to the application of the expression creating this GPathResult `name` - if the GPathResult corresponds to something with a name, e.g. a node `namespacePrefix` - the namespace prefix if any `namespaceTagHints` - the known tag to namespace mappings ### public Attributes([GPathResult](gpathresult) parent, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name, [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html "Map")<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String"), [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String")> namespaceTagHints) Parameters: `parent` - the GPathResult prior to the application of the expression creating this GPathResult `name` - if the GPathResult corresponds to something with a name, e.g. a node `namespaceTagHints` - the known tag to namespace mappings Method Detail ------------- ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public void build([GroovyObject](../../lang/groovyobject) builder) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html "Iterator") childNodes() Throws a `GroovyRuntimeException`, because attributes can have no children. ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [GPathResult](gpathresult) findAll([Closure](../../lang/closure) closure) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") protected [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html "Object") getNextNode([Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html "Iterator") iter) ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html "Iterator") iterator() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [List](https://docs.oracle.com/javase/8/docs/api/java/util/List.html "List") list() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") name() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html "Iterator") nodeIterator() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [GPathResult](gpathresult) parents() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html "String") text() ### @[Override](https://docs.oracle.com/javase/8/docs/api/java/lang/Override.html "Override") public [Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") writeTo([Writer](https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html "Writer") out)	programming_docs

Subsets and Splits

No community queries yet

The top public SQL queries from the community will appear here once available.