A B C D E F G H I J L M N O P Q R S T U V W X

A

AbstractShell - Class in org.springframework.shell.core
Provides a base Shell implementation.
AbstractShell() - Constructor for class org.springframework.shell.core.AbstractShell
 
AbstractShellStatusPublisher - Class in org.springframework.shell.event
Provides a convenience superclass for those shells wishing to publish status messages.
AbstractShellStatusPublisher() - Constructor for class org.springframework.shell.event.AbstractShellStatusPublisher
 
add(Class<?>) - Method in interface org.springframework.shell.converters.StaticFieldConverter
 
add(Class<?>) - Method in class org.springframework.shell.converters.StaticFieldConverterImpl
 
add(CommandMarker) - Method in class org.springframework.shell.core.SimpleParser
 
add(Converter<?>) - Method in class org.springframework.shell.core.SimpleParser
 
add(K, V) - Method in class org.springframework.shell.support.util.PairList
Adds a new pair to this list with the given key and value
addAll(Collection<? extends T>, Collection<T>) - Static method in class org.springframework.shell.support.util.CollectionUtils
Adds the given items to the given collection
addAttribute(String, String) - Method in class org.springframework.shell.support.util.XmlElementBuilder
Add an attribute to the current element.
addChild(Node) - Method in class org.springframework.shell.support.util.XmlElementBuilder
Add a child node to the current element.
addContextParam(WebXmlUtils.WebXmlParam, Document, String) - Static method in class org.springframework.shell.support.util.WebXmlUtils
Add a context param to the web.xml document
addErrorCode(Integer, String, Document, String) - Static method in class org.springframework.shell.support.util.WebXmlUtils
Add error code to web.xml document
addExceptionType(String, String, Document, String) - Static method in class org.springframework.shell.support.util.WebXmlUtils
Add exception type to web.xml document
addFilter(String, String, String, Document, String, WebXmlUtils.WebXmlParam...) - Static method in class org.springframework.shell.support.util.WebXmlUtils
Add a new filter definition to web.xml document.
addFilterAtPosition(WebXmlUtils.FilterPosition, String, String, String, String, String, Document, String, WebXmlUtils.WebXmlParam...) - Static method in class org.springframework.shell.support.util.WebXmlUtils
Add a new filter definition to web.xml document.
addFilterAtPosition(WebXmlUtils.FilterPosition, String, String, String, String, String, Document, String, List<WebXmlUtils.WebXmlParam>, List<WebXmlUtils.Dispatcher>) - Static method in class org.springframework.shell.support.util.WebXmlUtils
Add a new filter definition to web.xml document.
addListener(String, Document, String) - Static method in class org.springframework.shell.support.util.WebXmlUtils
Add listener element to web.xml document
addObjectToArray(Object[], Object) - Static method in class org.springframework.shell.support.util.ObjectUtils
Append the given Object to the given array, returning a new array consisting of the input array contents plus the given Object.
addResourcePathToPackagePath(Class<?>, String) - Static method in class org.springframework.shell.support.util.ClassUtils
Return a path suitable for use with ClassLoader.getResource (also suitable for use with Class.getResource by prepending a slash ('/') to the return value).
addSecurityConstraint(String, List<WebXmlUtils.WebResourceCollection>, List<String>, String, Document, String) - Static method in class org.springframework.shell.support.util.WebXmlUtils
Add a security constraint to a web.xml document
addServlet(String, String, String, Integer, Document, String, WebXmlUtils.WebXmlParam...) - Static method in class org.springframework.shell.support.util.WebXmlUtils
Add servlet element to the web.xml document
addShellStatusListener(ShellStatusListener) - Method in class org.springframework.shell.event.AbstractShellStatusPublisher
 
addShellStatusListener(ShellStatusListener) - Method in interface org.springframework.shell.event.ShellStatusProvider
Registers a new status listener.
addStringToArray(String[], String) - Static method in class org.springframework.shell.support.util.StringUtils
Append the given String to the given String array, returning a new array consisting of the input array contents plus the given String.
addWelcomeFile(String, Document, String) - Static method in class org.springframework.shell.support.util.WebXmlUtils
Add a welcome file definition to web.xml document
afterReturningInvocation(ParseResult, Object) - Method in interface org.springframework.shell.core.ExecutionProcessor
Method called after successfully invoking the target command (described by ParseResult).
afterThrowingInvocation(ParseResult, Throwable) - Method in interface org.springframework.shell.core.ExecutionProcessor
Method called after invoking the target command (described by ParseResult) had thrown an exception .
AnsiEscapeCode - Enum in org.springframework.shell.support.util
ANSI escape codes supported by JLine
AntPathMatcher - Class in org.springframework.shell.support.util
PathMatcher implementation for Ant-style path patterns.
AntPathMatcher() - Constructor for class org.springframework.shell.support.util.AntPathMatcher
 
append(String, byte) - Method in class org.springframework.shell.support.style.ToStringCreator
Append a byte field value.
append(String, short) - Method in class org.springframework.shell.support.style.ToStringCreator
Append a short field value.
append(String, int) - Method in class org.springframework.shell.support.style.ToStringCreator
Append a integer field value.
append(String, long) - Method in class org.springframework.shell.support.style.ToStringCreator
Append a long field value.
append(String, float) - Method in class org.springframework.shell.support.style.ToStringCreator
Append a float field value.
append(String, double) - Method in class org.springframework.shell.support.style.ToStringCreator
Append a double field value.
append(String, boolean) - Method in class org.springframework.shell.support.style.ToStringCreator
Append a boolean field value.
append(String, Object) - Method in class org.springframework.shell.support.style.ToStringCreator
Append a field value.
append(Object) - Method in class org.springframework.shell.support.style.ToStringCreator
Append the provided value.
applyRelativePath(String, String) - Static method in class org.springframework.shell.support.util.StringUtils
Apply the given relative path to the given path, assuming standard Java folder separation (i.e. "/" separators);
ARRAY_SUFFIX - Static variable in class org.springframework.shell.support.util.ClassUtils
Suffix for array class names: "[]"
arrayToCommaDelimitedString(Object[]) - Static method in class org.springframework.shell.support.util.StringUtils
Convenience method to return a String array as a CSV String.
arrayToDelimitedString(String, Object...) - Static method in class org.springframework.shell.support.util.StringUtils
Convenience method to return a String array as a delimited (e.g.
arrayToDelimitedString(Object[], String) - Static method in class org.springframework.shell.support.util.StringUtils
Convenience method to return a String array as a delimited (e.g.
arrayToList(Object) - Static method in class org.springframework.shell.support.util.CollectionUtils
Convert the supplied array into a List.
Assert - Class in org.springframework.shell.support.util
Assertion utility class that assists in validating arguments.
Assert() - Constructor for class org.springframework.shell.support.util.Assert
 
assertElementLegal(String) - Static method in class org.springframework.shell.support.util.XmlUtils
Checks the presented element for illegal characters that could cause malformed XML.
AvailableCommandsConverter - Class in org.springframework.shell.converters
Available commands converter.
AvailableCommandsConverter() - Constructor for class org.springframework.shell.converters.AvailableCommandsConverter
 

B

backOneDirectory(String) - Static method in class org.springframework.shell.support.util.FileUtils
Returns the given file system path minus its last element
BannerProvider - Interface in org.springframework.shell.plugin
Banner provider.
Base64 - Class in org.springframework.shell.support.util
Encodes and decodes to and from Base64 notation.
Base64.InputStream - Class in org.springframework.shell.support.util
A Base64.InputStream will read data from another java.io.InputStream, given in the constructor, and encode/decode to/from Base64 notation on the fly.
Base64.InputStream(InputStream) - Constructor for class org.springframework.shell.support.util.Base64.InputStream
Constructs a Base64.InputStream in DECODE mode.
Base64.InputStream(InputStream, int) - Constructor for class org.springframework.shell.support.util.Base64.InputStream
Constructs a Base64.InputStream in either ENCODE or DECODE mode.
Base64.OutputStream - Class in org.springframework.shell.support.util
A Base64.OutputStream will write data to another java.io.OutputStream, given in the constructor, and encode/decode to/from Base64 notation on the fly.
Base64.OutputStream(OutputStream) - Constructor for class org.springframework.shell.support.util.Base64.OutputStream
Constructs a Base64.OutputStream in ENCODE mode.
Base64.OutputStream(OutputStream, int) - Constructor for class org.springframework.shell.support.util.Base64.OutputStream
Constructs a Base64.OutputStream in either ENCODE or DECODE mode.
beforeInvocation(ParseResult) - Method in interface org.springframework.shell.core.ExecutionProcessor
Method called before invoking the target command (described by ParseResult).
BigDecimalConverter - Class in org.springframework.shell.converters
Converter for BigDecimal.
BigDecimalConverter() - Constructor for class org.springframework.shell.converters.BigDecimalConverter
 
BigIntegerConverter - Class in org.springframework.shell.converters
Converter for BigInteger.
BigIntegerConverter() - Constructor for class org.springframework.shell.converters.BigIntegerConverter
 
blockCommentBegin() - Method in class org.springframework.shell.core.AbstractShell
 
blockCommentFinish() - Method in class org.springframework.shell.core.AbstractShell
 
BooleanConverter - Class in org.springframework.shell.converters
Converter for Boolean.
BooleanConverter() - Constructor for class org.springframework.shell.converters.BooleanConverter
 
Bootstrap - Class in org.springframework.shell
Loads a Shell using Spring IoC container.
Bootstrap(String) - Constructor for class org.springframework.shell.Bootstrap
 
BUFFER_SIZE - Static variable in class org.springframework.shell.support.util.FileCopyUtils
 
build() - Method in class org.springframework.shell.support.util.XmlElementBuilder
Get the element instance.

C

calculateUniqueKeyFor(Element) - Static method in class org.springframework.shell.support.util.XmlRoundTripUtils
Create a base 64 encoded SHA1 hash key for a given XML element.
cancelRedrawProhibition() - Static method in class org.springframework.shell.core.JLineLogHandler
 
capitalize(String) - Static method in class org.springframework.shell.support.util.StringUtils
Capitalize a String, changing the first letter to upper case as per Character.toUpperCase(char).
CGLIB_CLASS_SEPARATOR - Static variable in class org.springframework.shell.support.util.ClassUtils
The CGLIB class separator character "$$"
CharacterConverter - Class in org.springframework.shell.converters
Converter for Character.
CharacterConverter() - Constructor for class org.springframework.shell.converters.CharacterConverter
 
CLASS_FILE_SUFFIX - Static variable in class org.springframework.shell.support.util.ClassUtils
The ".class" file suffix
classNamesToString(Class<?>...) - Static method in class org.springframework.shell.support.util.ClassUtils
Build a String that consists of the names of the classes/interfaces in the given array.
classNamesToString(Collection<Class<?>>) - Static method in class org.springframework.shell.support.util.ClassUtils
Build a String that consists of the names of the classes/interfaces in the given collection.
classPackageAsResourcePath(Class<?>) - Static method in class org.springframework.shell.support.util.ClassUtils
Given an input class object, return a string which consists of the class's package name as a pathname, i.e., all dots ('.') are replaced by slashes ('/').
ClassUtils - Class in org.springframework.shell.support.util
Miscellaneous class utility methods.
ClassUtils() - Constructor for class org.springframework.shell.support.util.ClassUtils
 
cleanPath(String) - Static method in class org.springframework.shell.support.util.StringUtils
Normalize the path by suppressing sequences like "path/.." and inner simple dots.
CliAvailabilityIndicator - Annotation Type in org.springframework.shell.core.annotation
Annotates a method that can indicate whether a particular command is presently available or not.
CliCommand - Annotation Type in org.springframework.shell.core.annotation
Annotates a method that provides a command to the shell.
CliOption - Annotation Type in org.springframework.shell.core.annotation
Annotates the arguments of a command methods, allowing it to declare the argument value as mandatory or optional with a default value.
CliOptionContext - Class in org.springframework.shell.core
Utility methods relating to shell option contexts
CliSimpleParserContext - Class in org.springframework.shell.core
Utility methods relating to shell simple parser contexts.
close() - Method in class org.springframework.shell.core.JLineLogHandler
 
close() - Method in class org.springframework.shell.support.logging.DeferredLogHandler
 
close() - Method in class org.springframework.shell.support.logging.LoggingOutputStream
 
close() - Method in class org.springframework.shell.support.util.Base64.OutputStream
Flushes and closes (I think, in the superclass) the stream.
closeQuietly(Closeable...) - Static method in class org.springframework.shell.support.util.IOUtils
Quietly closes each of the given Closeables, i.e. eats any IOExceptions arising.
closeQuietly(ZipFile...) - Static method in class org.springframework.shell.support.util.IOUtils
Quietly closes each of the given ZipFiles, i.e. eats any IOExceptions arising.
closeShell() - Method in class org.springframework.shell.core.JLineShell
Should be called by a subclass before deactivating the shell.
collectionToCommaDelimitedString(Collection<?>) - Static method in class org.springframework.shell.support.util.StringUtils
Convenience method to return a Collection as a CSV String.
collectionToDelimitedString(Collection<?>, String, String, String) - Static method in class org.springframework.shell.support.util.StringUtils
Convenience method to return a Collection as a delimited (e.g.
collectionToDelimitedString(Collection<?>, String) - Static method in class org.springframework.shell.support.util.StringUtils
Concatenates the given collection using the given delimiter between each item.
CollectionUtils - Class in org.springframework.shell.support.util
Miscellaneous collection utility methods.
commaDelimitedListToSet(String) - Static method in class org.springframework.shell.support.util.StringUtils
Convenience method to convert a CSV string list to a set.
commaDelimitedListToStringArray(String) - Static method in class org.springframework.shell.support.util.StringUtils
Convert a CSV list into an array of Strings.
command(String) - Method in class org.springframework.shell.commands.OsCommands
 
CommandMarker - Interface in org.springframework.shell.core
Marker interface indicating a provider of one or more shell commands.
commandNotFound(Logger, String) - Method in class org.springframework.shell.core.SimpleParser
 
compare(E, E) - Method in class org.springframework.shell.support.util.NaturalOrderComparator
 
compareDocuments(Document, Document) - Static method in class org.springframework.shell.support.util.XmlRoundTripUtils
This method will compare the original document with the proposed document and return true if adjustments to the original document were necessary.
compareNodes(Node, Node) - Static method in class org.springframework.shell.support.util.XmlUtils
Compares two DOM nodes by comparing the representations of the nodes as XML strings
complete(String, int, List) - Method in class org.springframework.shell.core.JLineCompletorAdapter
 
complete(String, int, List<String>) - Method in interface org.springframework.shell.core.Parser
Populates a list of completion candidates.
complete(String, int, List<String>) - Method in class org.springframework.shell.core.SimpleParser
 
completeAdvanced(String, int, List<Completion>) - Method in interface org.springframework.shell.core.Parser
Populates a list of completion candidates.
completeAdvanced(String, int, List<Completion>) - Method in class org.springframework.shell.core.SimpleParser
 
Completion - Class in org.springframework.shell.core
 
Completion(String) - Constructor for class org.springframework.shell.core.Completion
Constructor
Completion(String, String, String, int) - Constructor for class org.springframework.shell.core.Completion
Constructor
completionKeys - Static variable in class org.springframework.shell.core.AbstractShell
 
concatenateStringArrays(String[], String[]) - Static method in class org.springframework.shell.support.util.StringUtils
Concatenate the given String arrays into one, with overlapping array elements included twice.
contains(Iterator<?>, Object) - Static method in class org.springframework.shell.support.util.CollectionUtils
Check whether the given Iterator contains the given element.
contains(Enumeration<?>, Object) - Static method in class org.springframework.shell.support.util.CollectionUtils
Check whether the given Enumeration contains the given element.
contains(String, String) - Static method in class org.springframework.shell.support.util.StringUtils
Indicates whether the given substring occurs within the given string.
containsAny(Collection<?>, Collection<?>) - Static method in class org.springframework.shell.support.util.CollectionUtils
Return true if any element in 'candidates' is contained in 'source'; otherwise returns false.
containsElement(Object[], Object) - Static method in class org.springframework.shell.support.util.ObjectUtils
Check whether the given array contains the given element.
containsInstance(Collection<?>, Object) - Static method in class org.springframework.shell.support.util.CollectionUtils
Check whether the given Collection contains the given element instance.
containsWhitespace(CharSequence) - Static method in class org.springframework.shell.support.util.StringUtils
Check whether the given CharSequence contains any whitespace characters.
containsWhitespace(String) - Static method in class org.springframework.shell.support.util.StringUtils
Check whether the given String contains any whitespace characters.
convertClassNameToResourcePath(String) - Static method in class org.springframework.shell.support.util.ClassUtils
Convert a "."
Converter<T> - Interface in org.springframework.shell.core
Converts between Strings (as displayed by and entered via the shell) and Java objects
convertFromText(String, Class<?>, String) - Method in class org.springframework.shell.commands.HintConverter
 
convertFromText(String, Class<?>, String) - Method in class org.springframework.shell.converters.AvailableCommandsConverter
 
convertFromText(String, Class<?>, String) - Method in class org.springframework.shell.converters.BigDecimalConverter
 
convertFromText(String, Class<?>, String) - Method in class org.springframework.shell.converters.BigIntegerConverter
 
convertFromText(String, Class<?>, String) - Method in class org.springframework.shell.converters.BooleanConverter
 
convertFromText(String, Class<?>, String) - Method in class org.springframework.shell.converters.CharacterConverter
 
convertFromText(String, Class<?>, String) - Method in class org.springframework.shell.converters.DateConverter
 
convertFromText(String, Class<?>, String) - Method in class org.springframework.shell.converters.DoubleConverter
 
convertFromText(String, Class<?>, String) - Method in class org.springframework.shell.converters.EnumConverter
 
convertFromText(String, Class<?>, String) - Method in class org.springframework.shell.converters.FileConverter
 
convertFromText(String, Class<?>, String) - Method in class org.springframework.shell.converters.FloatConverter
 
convertFromText(String, Class<?>, String) - Method in class org.springframework.shell.converters.IntegerConverter
 
convertFromText(String, Class<?>, String) - Method in class org.springframework.shell.converters.LocaleConverter
 
convertFromText(String, Class<?>, String) - Method in class org.springframework.shell.converters.LongConverter
 
convertFromText(String, Class<?>, String) - Method in class org.springframework.shell.converters.ShortConverter
 
convertFromText(String, Class<?>, String) - Method in class org.springframework.shell.converters.StaticFieldConverterImpl
 
convertFromText(String, Class<?>, String) - Method in class org.springframework.shell.converters.StringConverter
 
convertFromText(String, Class<?>, String) - Method in interface org.springframework.shell.core.Converter
Converts from the given String value to type T
convertId(String) - Static method in class org.springframework.shell.support.util.XmlUtils
Converts a XHTML compliant id (used in jspx) to a CSS3 selector spec compliant id.
convertResourcePathToClassName(String) - Static method in class org.springframework.shell.support.util.ClassUtils
Convert a "/"-based resource path to a "."
copy(File, File) - Static method in class org.springframework.shell.support.util.FileCopyUtils
Copy the contents of the given input File to the given output File.
copy(byte[], File) - Static method in class org.springframework.shell.support.util.FileCopyUtils
Copy the contents of the given byte array to the given output File.
copy(InputStream, OutputStream) - Static method in class org.springframework.shell.support.util.FileCopyUtils
Copy the contents of the given InputStream to the given OutputStream.
copy(byte[], OutputStream) - Static method in class org.springframework.shell.support.util.FileCopyUtils
Copy the contents of the given byte array to the given OutputStream.
copy(Reader, Writer) - Static method in class org.springframework.shell.support.util.FileCopyUtils
Copy the contents of the given Reader to the given Writer.
copy(String, Writer) - Static method in class org.springframework.shell.support.util.FileCopyUtils
Copy the contents of the given String to the given output Writer.
COPYABLE_FIELDS - Static variable in class org.springframework.shell.support.util.ReflectionUtils
Pre-built FieldFilter that matches all non-static, non-final fields.
copyRecursively(File, File, boolean) - Static method in class org.springframework.shell.support.util.FileUtils
Copies the specified source directory to the destination.
copyToByteArray(File) - Static method in class org.springframework.shell.support.util.FileCopyUtils
Copy the contents of the given input File into a new byte array.
copyToByteArray(InputStream) - Static method in class org.springframework.shell.support.util.FileCopyUtils
Copy the contents of the given InputStream into a new byte array.
copyToString(Reader) - Static method in class org.springframework.shell.support.util.FileCopyUtils
Copy the contents of the given Reader into a String.
copyToString(File) - Static method in class org.springframework.shell.support.util.FileCopyUtils
Returns the contents of the given File as a String.
countOccurrencesOf(String, String) - Static method in class org.springframework.shell.support.util.StringUtils
Count the occurrences of the substring in string s.
createAndRegisterBeanDefinition(AnnotationConfigApplicationContext, Class) - Method in class org.springframework.shell.Bootstrap
 
createAndRegisterBeanDefinition(AnnotationConfigApplicationContext, Class, String) - Method in class org.springframework.shell.Bootstrap
 
createAnsiWindowsReader() - Method in class org.springframework.shell.core.JLineShell
 
createChildElement(String, Node, Document) - Static method in class org.springframework.shell.support.util.DomUtils
Creates a child element with the given name and parent.
createChildIfNotExists(String, Node, Document) - Static method in class org.springframework.shell.support.util.DomUtils
Returns the child node with the given tag name, creating it if it does not exist.
createCompositeInterface(Class<?>[], ClassLoader) - Static method in class org.springframework.shell.support.util.ClassUtils
Create a composite interface Class for the given interfaces, implementing the given interfaces in one single Class.
createConsoleReader() - Method in class org.springframework.shell.core.JLineShell
Creates new jline ConsoleReader.
createIndentingTransformer() - Static method in class org.springframework.shell.support.util.XmlUtils
 
createTextElement(Document, String, String) - Static method in class org.springframework.shell.support.util.XmlUtils
Creates an Element containing the given text
CURRENT_DIRECTORY - Static variable in class org.springframework.shell.support.util.FileUtils
The relative file path to the current directory.
customizePlugin() - Method in class org.springframework.shell.core.JLineShellComponent
 

D

date() - Method in class org.springframework.shell.core.AbstractShell
 
DateConverter - Class in org.springframework.shell.converters
Converter for Date.
DateConverter() - Constructor for class org.springframework.shell.converters.DateConverter
 
DateConverter(DateFormat) - Constructor for class org.springframework.shell.converters.DateConverter
 
declaresException(Method, Class<?>) - Static method in class org.springframework.shell.support.util.ReflectionUtils
Determine whether the given method explicitly declares the given exception or one of its superclasses, which means that an exception of that type can be propagated as-is within a reflective invocation.
DECODE - Static variable in class org.springframework.shell.support.util.Base64
Specify decoding in first bit.
decode(byte[]) - Static method in class org.springframework.shell.support.util.Base64
Low-level access to decoding ASCII characters in the form of a byte array.
decode(byte[], int, int, int) - Static method in class org.springframework.shell.support.util.Base64
Low-level access to decoding ASCII characters in the form of a byte array.
decode(String) - Static method in class org.springframework.shell.support.util.Base64
Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it.
decode(String, int) - Static method in class org.springframework.shell.support.util.Base64
Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it.
decodeFileToFile(String, String) - Static method in class org.springframework.shell.support.util.Base64
Reads infile and decodes it to outfile.
decodeFromFile(String) - Static method in class org.springframework.shell.support.util.Base64
Convenience method for reading a base64-encoded file and decoding it.
decodeToFile(String, String) - Static method in class org.springframework.shell.support.util.Base64
Convenience method for decoding data to a file.
decodeToObject(String) - Static method in class org.springframework.shell.support.util.Base64
Attempts to decode Base64 data and deserialize a Java Object within.
decodeToObject(String, int, ClassLoader) - Static method in class org.springframework.shell.support.util.Base64
Attempts to decode Base64 data and deserialize a Java Object within.
decorate(String, AnsiEscapeCode...) - Static method in enum org.springframework.shell.support.util.AnsiEscapeCode
Decorates the given text with the given escape codes (turning them off afterwards)
DEFAULT_PATH_SEPARATOR - Static variable in class org.springframework.shell.support.util.AntPathMatcher
Default path separator: "/"
DefaultBannerProvider - Class in org.springframework.shell.plugin.support
Default Banner provider.
DefaultBannerProvider() - Constructor for class org.springframework.shell.plugin.support.DefaultBannerProvider
 
DefaultHistoryFileNameProvider - Class in org.springframework.shell.plugin.support
Default history file provider.
DefaultHistoryFileNameProvider() - Constructor for class org.springframework.shell.plugin.support.DefaultHistoryFileNameProvider
 
defaultIfEmpty(String, String...) - Static method in class org.springframework.shell.support.util.StringUtils
Returns either the passed in String, or if it's blank, the first of the given default values that is not blank.
defaultIfNull(T, T) - Static method in class org.springframework.shell.support.util.ObjectUtils
Returns the given object if not null, otherwise the given default value
DefaultPromptProvider - Class in org.springframework.shell.plugin.support
Default prompt provider.
DefaultPromptProvider() - Constructor for class org.springframework.shell.plugin.support.DefaultPromptProvider
 
DefaultToStringStyler - Class in org.springframework.shell.support.style
Spring's default toString() styler.
DefaultToStringStyler(ValueStyler) - Constructor for class org.springframework.shell.support.style.DefaultToStringStyler
Create a new DefaultToStringStyler.
DefaultValueStyler - Class in org.springframework.shell.support.style
Converts objects to String form, generally for debugging purposes, using Spring's toString styling conventions.
DefaultValueStyler() - Constructor for class org.springframework.shell.support.style.DefaultValueStyler
 
DeferredLogHandler - Class in org.springframework.shell.support.logging
Defers the publication of JDK LogRecord instances until a target Handler is registered.
DeferredLogHandler(Handler, Level) - Constructor for class org.springframework.shell.support.logging.DeferredLogHandler
Creates an instance that will publish all recorded LogRecord instances to the specified fallback Handler if an event of the specified Level is received.
delete(String, String) - Static method in class org.springframework.shell.support.util.StringUtils
Delete all occurrences of the given substring.
deleteAny(String, String) - Static method in class org.springframework.shell.support.util.StringUtils
Delete any character in a given String.
deleteRecursively(File) - Static method in class org.springframework.shell.support.util.FileUtils
Deletes the specified File.
delimitedListToStringArray(String, String) - Static method in class org.springframework.shell.support.util.StringUtils
Take a String which is a delimited list and convert it to a String array.
delimitedListToStringArray(String, String, String) - Static method in class org.springframework.shell.support.util.StringUtils
Take a String which is a delimited list and convert it to a String array.
denotesAbsolutePath(String) - Static method in class org.springframework.shell.support.util.FileUtils
Checks if the provided fileName denotes an absolute path on the file system.
displayFile(String, Class<?>, boolean) - Static method in class org.springframework.shell.support.logging.MessageDisplayUtils
Displays the requested file via the LOGGER API.
displayFile(String, Class<?>) - Static method in class org.springframework.shell.support.logging.MessageDisplayUtils
Same as MessageDisplayUtils.displayFile(String, Class, boolean) except it passes false as the final argument.
DO_BREAK_LINES - Static variable in class org.springframework.shell.support.util.Base64
Do break lines when encoding.
doesNotContain(String, String, String) - Static method in class org.springframework.shell.support.util.Assert
Assert that the given text does not contain the given substring.
doesNotContain(String, String) - Static method in class org.springframework.shell.support.util.Assert
Assert that the given text does not contain the given substring.
doMatch(String, String, boolean, Map<String, String>) - Method in class org.springframework.shell.support.util.AntPathMatcher
Actually match the given path against the given pattern.
DomUtils - Class in org.springframework.shell.support.util
Convenience methods for working with the DOM API, in particular for working with DOM Nodes and DOM Elements.
DONT_GUNZIP - Static variable in class org.springframework.shell.support.util.Base64
Specify that gzipped data should not be automatically gunzipped.
DoubleConverter - Class in org.springframework.shell.converters
Converter for Double.
DoubleConverter() - Constructor for class org.springframework.shell.converters.DoubleConverter
 
doWith(Field) - Method in interface org.springframework.shell.support.util.ReflectionUtils.FieldCallback
Perform an operation using the given field.
doWith(Method) - Method in interface org.springframework.shell.support.util.ReflectionUtils.MethodCallback
Perform an operation using the given method.
doWithFields(Class<?>, ReflectionUtils.FieldCallback) - Static method in class org.springframework.shell.support.util.ReflectionUtils
Invoke the given callback on all fields in the target class, going up the class hierarchy to get all declared fields.
doWithFields(Class<?>, ReflectionUtils.FieldCallback, ReflectionUtils.FieldFilter) - Static method in class org.springframework.shell.support.util.ReflectionUtils
Invoke the given callback on all fields in the target class, going up the class hierarchy to get all declared fields.
doWithMethods(Class<?>, ReflectionUtils.MethodCallback) - Static method in class org.springframework.shell.support.util.ReflectionUtils
Perform the given callback operation on all matching methods of the given class and superclasses.
doWithMethods(Class<?>, ReflectionUtils.MethodCallback, ReflectionUtils.MethodFilter) - Static method in class org.springframework.shell.support.util.ReflectionUtils
Perform the given callback operation on all matching methods of the given class and superclasses.

E

ENCODE - Static variable in class org.springframework.shell.support.util.Base64
Specify encoding in first bit.
encode(ByteBuffer, ByteBuffer) - Static method in class org.springframework.shell.support.util.Base64
Performs Base64 encoding on the raw ByteBuffer, writing it to the encoded ByteBuffer.
encode(ByteBuffer, CharBuffer) - Static method in class org.springframework.shell.support.util.Base64
Performs Base64 encoding on the raw ByteBuffer, writing it to the encoded CharBuffer.
encode(byte[]) - Static method in class org.springframework.shell.support.util.HexUtils
 
encodeBytes(byte[]) - Static method in class org.springframework.shell.support.util.Base64
Encodes a byte array into Base64 notation.
encodeBytes(byte[], int) - Static method in class org.springframework.shell.support.util.Base64
Encodes a byte array into Base64 notation.
encodeBytes(byte[], int, int) - Static method in class org.springframework.shell.support.util.Base64
Encodes a byte array into Base64 notation.
encodeBytes(byte[], int, int, int) - Static method in class org.springframework.shell.support.util.Base64
Encodes a byte array into Base64 notation.
encodeBytesToBytes(byte[]) - Static method in class org.springframework.shell.support.util.Base64
Similar to Base64.encodeBytes(byte[]) but returns a byte array instead of instantiating a String.
encodeBytesToBytes(byte[], int, int, int) - Static method in class org.springframework.shell.support.util.Base64
Similar to Base64.encodeBytes(byte[], int, int, int) but returns a byte array instead of instantiating a String.
encodeFileToFile(String, String) - Static method in class org.springframework.shell.support.util.Base64
Reads infile and encodes it to outfile.
encodeFromFile(String) - Static method in class org.springframework.shell.support.util.Base64
Convenience method for reading a binary file and base64-encoding it.
encodeObject(Serializable) - Static method in class org.springframework.shell.support.util.Base64
Serializes an object and returns the Base64-encoded version of that serialized object.
encodeObject(Serializable, int) - Static method in class org.springframework.shell.support.util.Base64
Serializes an object and returns the Base64-encoded version of that serialized object.
encodeToFile(byte[], String) - Static method in class org.springframework.shell.support.util.Base64
Convenience method for encoding data to a file.
endsWithIgnoreCase(String, String) - Static method in class org.springframework.shell.support.util.StringUtils
Test if the given String ends with the specified suffix, ignoring upper/lower case.
ensureTrailingSeparator(String) - Static method in class org.springframework.shell.support.util.FileUtils
Ensures that the given path has exactly one trailing File.separator
EnumConverter - Class in org.springframework.shell.converters
Converter for Enum.
EnumConverter() - Constructor for class org.springframework.shell.converters.EnumConverter
 
equals(Object) - Method in class org.springframework.shell.core.Completion
 
equals(Object) - Method in class org.springframework.shell.core.MethodTarget
 
equals(Object) - Method in class org.springframework.shell.event.ParseResult
 
equals(Object) - Method in class org.springframework.shell.event.ShellStatus
 
equals(Object) - Method in class org.springframework.shell.support.util.Pair
 
equals(String, String) - Static method in class org.springframework.shell.support.util.StringUtils
Indicates whether the two given strings are equal, including case, where null is (only) equal to null.
EssentialCommands - Class in org.springframework.shell.commands
 
EssentialCommands() - Constructor for class org.springframework.shell.commands.EssentialCommands
 
ExceptionUtils - Class in org.springframework.shell.support.util
Methods for working with exceptions.
ExceptionUtils() - Constructor for class org.springframework.shell.support.util.ExceptionUtils
 
execute(ParseResult) - Method in interface org.springframework.shell.core.ExecutionStrategy
Executes the method indicated by the ParseResult.
execute(ParseResult) - Method in class org.springframework.shell.core.SimpleExecutionStrategy
 
executeCommand(String) - Method in interface org.springframework.shell.commands.OsOperations
Attempts the execution of a commands and delegates the output to the standard logger.
executeCommand(String) - Method in class org.springframework.shell.commands.OsOperationsImpl
 
executeCommand(String) - Method in class org.springframework.shell.core.AbstractShell
 
executeCommand(String) - Method in interface org.springframework.shell.core.Shell
Runs the specified command.
executeScriptLine(String) - Method in class org.springframework.shell.core.AbstractShell
Execute the single line from a script.
ExecutionProcessor - Interface in org.springframework.shell.core
Extension interface allowing command provider to be called in a generic fashion just before, and right after, executing a command.
ExecutionStrategy - Interface in org.springframework.shell.core
Strategy interface to permit the controlled execution of methods.
exitShellRequest - Variable in class org.springframework.shell.core.AbstractShell
 
ExitShellRequest - Class in org.springframework.shell.core
An immutable representation of a request to exit the shell.
extractPathWithinPattern(String, String) - Method in class org.springframework.shell.support.util.AntPathMatcher
Given a pattern and a full path, determine the pattern-mapped part.
extractPathWithinPattern(String, String) - Method in interface org.springframework.shell.support.util.PathMatcher
Given a pattern and a full path, determine the pattern-mapped part.
extractRootCause(Throwable) - Static method in class org.springframework.shell.support.util.ExceptionUtils
Obtains the root cause of an exception, if available.
extractUriTemplateVariables(String, String) - Method in class org.springframework.shell.support.util.AntPathMatcher
 
extractUriTemplateVariables(String, String) - Method in interface org.springframework.shell.support.util.PathMatcher
Given a pattern and a full path, extract the URI template variables.

F

FATAL_EXIT - Static variable in class org.springframework.shell.core.ExitShellRequest
 
FileConverter - Class in org.springframework.shell.converters
Converter for File.
FileConverter() - Constructor for class org.springframework.shell.converters.FileConverter
 
FileCopyUtils - Class in org.springframework.shell.support.util
Simple utility methods for file and stream copying.
FileUtils - Class in org.springframework.shell.support.util
Utilities for handling File instances.
filter(Iterable<? extends T>, Filter<T>) - Static method in class org.springframework.shell.support.util.CollectionUtils
Filters (removes elements from) the given Iterable using the given filter.
Filter<T> - Interface in org.springframework.shell.support.util
Allows filtering of objects of type T.
findElements(String, Element) - Static method in class org.springframework.shell.support.util.XmlUtils
Checks in under a given root element whether it can find a child elements which match the XPath expression supplied.
findField(Class<?>, String) - Static method in class org.springframework.shell.support.util.ReflectionUtils
Attempt to find a field on the supplied Class with the supplied name.
findField(Class<?>, String, Class<?>) - Static method in class org.springframework.shell.support.util.ReflectionUtils
Attempt to find a field on the supplied Class with the supplied name and/or type.
findFirstAttribute(String, Element) - Static method in class org.springframework.shell.support.util.XmlUtils
Checks for a given element whether it can find an attribute which matches the XPath expression supplied.
findFirstElement(String, Node) - Static method in class org.springframework.shell.support.util.XmlUtils
Searches the given parent element for a child element matching the given XPath expression.
findFirstElementByName(String, Element) - Static method in class org.springframework.shell.support.util.DomUtils
Checks in under a given root element whether it can find a child element which matches the name supplied.
findFirstElementByName(String, Element) - Static method in class org.springframework.shell.support.util.XmlUtils
Deprecated. use DomUtils.findFirstElementByName(String, Element) instead
findFirstMatch(Collection<?>, Collection<?>) - Static method in class org.springframework.shell.support.util.CollectionUtils
Return the first element in 'candidates' that is contained in 'source'.
findMethod(Class<?>, String) - Static method in class org.springframework.shell.support.util.ReflectionUtils
Attempt to find a Method on the supplied class with the supplied name and no parameters.
findMethod(Class<?>, String, Class<?>[]) - Static method in class org.springframework.shell.support.util.ReflectionUtils
Attempt to find a Method on the supplied class with the supplied name and parameter types.
findNode(String, Node) - Static method in class org.springframework.shell.support.util.XmlUtils
Checks in under a given root element whether it can find a child node which matches the XPath expression supplied.
findRequiredElement(String, Element) - Static method in class org.springframework.shell.support.util.XmlUtils
Checks in under a given root element whether it can find a child element which matches the XPath expression supplied.
findResources(String) - Method in class org.springframework.shell.core.AbstractShell
Returns any classpath resources with the given path
findResources(String) - Method in class org.springframework.shell.core.JLineShellComponent
 
findValueOfType(Collection<?>, Class<T>) - Static method in class org.springframework.shell.support.util.CollectionUtils
Find a single value of the given type in the given Collection.
findValueOfType(Collection<?>, Class<?>...) - Static method in class org.springframework.shell.support.util.CollectionUtils
Find a single value of one of the given types in the given Collection: searching the Collection for a value of the first type, then searching for a value of the second type, etc.
firstElementOf(Collection<? extends T>) - Static method in class org.springframework.shell.support.util.CollectionUtils
Returns the first element of the given collection
flash(Level, String, String) - Method in class org.springframework.shell.core.AbstractShell
Simple implementation of AbstractShell.flash(Level, String, String) that simply displays the message via the logger.
flash(Level, String, String) - Method in class org.springframework.shell.core.JLineShell
 
flash(Level, String, String) - Method in interface org.springframework.shell.core.Shell
Displays a progress notification to the user.
flashCustom() - Method in class org.springframework.shell.core.AbstractShell
 
FloatConverter - Class in org.springframework.shell.converters
Converter for Float.
FloatConverter() - Constructor for class org.springframework.shell.converters.FloatConverter
 
flush() - Method in class org.springframework.shell.core.JLineLogHandler
 
flush() - Method in class org.springframework.shell.support.logging.DeferredLogHandler
 
flush() - Method in class org.springframework.shell.support.logging.LoggingOutputStream
 
flushAllHandlers(Logger) - Static method in class org.springframework.shell.support.logging.HandlerUtils
Forces all Handler instances registered in the presented Logger to be flushed.
flushBase64() - Method in class org.springframework.shell.support.util.Base64.OutputStream
Pads the buffer without closing the stream.
forName(String) - Static method in class org.springframework.shell.support.util.ClassUtils
Deprecated. as of Spring 3.0, in favor of specifying a ClassLoader explicitly: see ClassUtils.forName(String, ClassLoader)
forName(String, ClassLoader) - Static method in class org.springframework.shell.support.util.ClassUtils
Replacement for Class.forName() that also returns Class instances for primitives (e.g."

G

getAllDeclaredMethods(Class<?>) - Static method in class org.springframework.shell.support.util.ReflectionUtils
Get all declared methods on the leaf class and all superclasses.
getAllInterfaces(Object) - Static method in class org.springframework.shell.support.util.ClassUtils
Return all interfaces that the given instance implements as array, including ones implemented by superclasses.
getAllInterfacesAsSet(Object) - Static method in class org.springframework.shell.support.util.ClassUtils
Return all interfaces that the given instance implements as Set, including ones implemented by superclasses.
getAllInterfacesForClass(Class<?>) - Static method in class org.springframework.shell.support.util.ClassUtils
Return all interfaces that the given class implements as array, including ones implemented by superclasses.
getAllInterfacesForClass(Class<?>, ClassLoader) - Static method in class org.springframework.shell.support.util.ClassUtils
Return all interfaces that the given class implements as array, including ones implemented by superclasses.
getAllInterfacesForClassAsSet(Class) - Static method in class org.springframework.shell.support.util.ClassUtils
Return all interfaces that the given class implements as Set, including ones implemented by superclasses.
getAllInterfacesForClassAsSet(Class, ClassLoader) - Static method in class org.springframework.shell.support.util.ClassUtils
Return all interfaces that the given class implements as Set, including ones implemented by superclasses.
getAllPossibleValues(List<Completion>, Class<?>, String, String, MethodTarget) - Method in class org.springframework.shell.commands.HintConverter
 
getAllPossibleValues(List<Completion>, Class<?>, String, String, MethodTarget) - Method in class org.springframework.shell.converters.AvailableCommandsConverter
 
getAllPossibleValues(List<Completion>, Class<?>, String, String, MethodTarget) - Method in class org.springframework.shell.converters.BigDecimalConverter
 
getAllPossibleValues(List<Completion>, Class<?>, String, String, MethodTarget) - Method in class org.springframework.shell.converters.BigIntegerConverter
 
getAllPossibleValues(List<Completion>, Class<?>, String, String, MethodTarget) - Method in class org.springframework.shell.converters.BooleanConverter
 
getAllPossibleValues(List<Completion>, Class<?>, String, String, MethodTarget) - Method in class org.springframework.shell.converters.CharacterConverter
 
getAllPossibleValues(List<Completion>, Class<?>, String, String, MethodTarget) - Method in class org.springframework.shell.converters.DateConverter
 
getAllPossibleValues(List<Completion>, Class<?>, String, String, MethodTarget) - Method in class org.springframework.shell.converters.DoubleConverter
 
getAllPossibleValues(List<Completion>, Class<?>, String, String, MethodTarget) - Method in class org.springframework.shell.converters.EnumConverter
 
getAllPossibleValues(List<Completion>, Class<?>, String, String, MethodTarget) - Method in class org.springframework.shell.converters.FileConverter
 
getAllPossibleValues(List<Completion>, Class<?>, String, String, MethodTarget) - Method in class org.springframework.shell.converters.FloatConverter
 
getAllPossibleValues(List<Completion>, Class<?>, String, String, MethodTarget) - Method in class org.springframework.shell.converters.IntegerConverter
 
getAllPossibleValues(List<Completion>, Class<?>, String, String, MethodTarget) - Method in class org.springframework.shell.converters.LocaleConverter
 
getAllPossibleValues(List<Completion>, Class<?>, String, String, MethodTarget) - Method in class org.springframework.shell.converters.LongConverter
 
getAllPossibleValues(List<Completion>, Class<?>, String, String, MethodTarget) - Method in class org.springframework.shell.converters.ShortConverter
 
getAllPossibleValues(List<Completion>, Class<?>, String, String, MethodTarget) - Method in class org.springframework.shell.converters.StaticFieldConverterImpl
 
getAllPossibleValues(List<Completion>, Class<?>, String, String, MethodTarget) - Method in class org.springframework.shell.converters.StringConverter
 
getAllPossibleValues(List<Completion>, Class<?>, String, String, MethodTarget) - Method in interface org.springframework.shell.core.Converter
Populates the given list with the possible completions
getANSIBuffer() - Static method in class org.springframework.shell.core.JLineLogHandler
Makes text brighter if requested through system property 'roo.bright' and works around issue on Windows in using reverse() in combination with the Jansi lib, which leaves its 'negative' flag set unless reset explicitly.
getArguments() - Method in class org.springframework.shell.event.ParseResult
 
getBanner() - Method in interface org.springframework.shell.plugin.BannerProvider
Returns the banner.
getBanner() - Method in class org.springframework.shell.plugin.support.DefaultBannerProvider
 
getCanonicalPath(File) - Static method in class org.springframework.shell.support.util.FileUtils
Returns the canonical path of the given File.
getChildElementByTagName(Element, String) - Static method in class org.springframework.shell.support.util.DomUtils
Returns the first child element identified by its name.
getChildElementsByTagName(Element, String[]) - Static method in class org.springframework.shell.support.util.DomUtils
Retrieve all child elements of the given DOM element that match any of the given element names.
getChildElementsByTagName(Element, String) - Static method in class org.springframework.shell.support.util.DomUtils
Retrieve all child elements of the given DOM element that match the given element name.
getChildElementValueByTagName(Element, String) - Static method in class org.springframework.shell.support.util.DomUtils
Returns the first child element value identified by its name.
getChildTextContent(Element, String) - Static method in class org.springframework.shell.support.util.DomUtils
Returns the text content of the first child of the given parent that has the given tag name, if any.
getClassFileName(Class<?>) - Static method in class org.springframework.shell.support.util.ClassUtils
Determine the name of the class file, relative to the containing package: e.g.
getConfiguration(Class<?>) - Static method in class org.springframework.shell.support.util.XmlUtils
Returns the root element of an addon's configuration file.
getConstructorIfAvailable(Class<T>, Class<?>...) - Static method in class org.springframework.shell.support.util.ClassUtils
Determine whether the given class has a public constructor with the given signature, and return it if available (else return null).
getCurrentTopics() - Method in interface org.springframework.shell.commands.HintOperations
 
getCurrentTopics() - Method in class org.springframework.shell.commands.ResourceBundleHintOperations
 
getDefaultClassLoader() - Static method in class org.springframework.shell.support.util.ClassUtils
Return the default ClassLoader to use: typically the thread context ClassLoader, if available; the ClassLoader that loaded the ClassUtils class will be used as fallback.
getDescription() - Method in class org.springframework.shell.support.util.WebXmlUtils.WebResourceCollection
 
getDescriptiveType(Object) - Static method in class org.springframework.shell.support.util.ClassUtils
Return a descriptive name for the given object's type: usually simply the class name, but component type class name + "[]" for arrays, and an appended list of implemented interfaces for JDK proxies.
getDisplayString(Object) - Static method in class org.springframework.shell.support.util.ObjectUtils
Return a content-based String representation if obj is not null; otherwise returns an empty String.
getDocumentBuilder() - Static method in class org.springframework.shell.support.util.XmlUtils
 
getEveryCommand() - Method in class org.springframework.shell.core.SimpleParser
 
getExecutionStrategy() - Method in class org.springframework.shell.core.AbstractShell
 
getExecutionStrategy() - Method in class org.springframework.shell.core.JLineShellComponent
 
getExitCode() - Method in class org.springframework.shell.core.ExitShellRequest
 
getExitShellRequest() - Method in class org.springframework.shell.core.AbstractShell
 
getExitShellRequest() - Method in interface org.springframework.shell.core.Shell
 
getField(Field, Object) - Static method in class org.springframework.shell.support.util.ReflectionUtils
Get the field represented by the supplied field object on the specified target object.
getFile(Class<?>, String) - Static method in class org.springframework.shell.support.util.FileUtils
Loads the given file from the classpath.
getFilename(String) - Static method in class org.springframework.shell.support.util.StringUtils
Extract the filename from the given path, e.g.
getFilenameExtension(String) - Static method in class org.springframework.shell.support.util.StringUtils
Extract the filename extension from the given path, e.g.
getFileSeparatorAsRegex() - Static method in class org.springframework.shell.support.util.FileUtils
Returns the platform-specific file separator as a regular expression.
getFirstDirectory(String) - Static method in class org.springframework.shell.support.util.FileUtils
Returns the part of the given path that represents a directory, in other words the given path if it's already a directory, or the parent directory if it's a file.
getFormattedValue() - Method in class org.springframework.shell.core.Completion
 
getHeading() - Method in class org.springframework.shell.core.Completion
 
getHistoryFileName() - Method in class org.springframework.shell.core.JLineShell
get history file name from provider.
getHistoryFileName() - Method in class org.springframework.shell.core.JLineShellComponent
get history file name from provider.
getHistoryFileName() - Method in interface org.springframework.shell.plugin.HistoryFileNameProvider
get history file name
getHistoryFileName() - Method in class org.springframework.shell.plugin.support.DefaultHistoryFileNameProvider
 
getHistorySize() - Method in class org.springframework.shell.core.JLineShell
 
getHome() - Method in class org.springframework.shell.core.AbstractShell
Obtains the home directory for the current shell instance.
getHome() - Method in interface org.springframework.shell.core.Shell
Returns the home directory of the current running shell instance
getHomeAsString() - Method in class org.springframework.shell.core.AbstractShell
 
getHomeAsString() - Method in class org.springframework.shell.core.JLineShell
Obtains the "roo.home" from the system property, falling back to the current working directory if missing.
getHttpMethods() - Method in class org.springframework.shell.support.util.WebXmlUtils.WebResourceCollection
 
getIdentityHexString(Object) - Static method in class org.springframework.shell.support.util.ObjectUtils
Return a hex String form of an object's identity hash code.
getInputStream(Class<?>, String) - Static method in class org.springframework.shell.support.util.FileUtils
Loads the given file from the classpath.
getInstance() - Method in class org.springframework.shell.event.ParseResult
 
getKey() - Method in class org.springframework.shell.core.MethodTarget
 
getKey() - Method in class org.springframework.shell.support.util.Pair
Returns the key
getKeys() - Method in class org.springframework.shell.support.util.PairList
Returns the keys of each Pair in this list
getLogger(Class<?>) - Static method in class org.springframework.shell.support.logging.HandlerUtils
Obtains a Logger that guarantees to set the Level to Level.FINE if it is part of org.springframework.roo.
getMessage() - Method in class org.springframework.shell.event.ShellStatus
 
getMethod() - Method in class org.springframework.shell.core.MethodTarget
 
getMethod() - Method in class org.springframework.shell.event.ParseResult
 
getMethodCountForName(Class<?>, String) - Static method in class org.springframework.shell.support.util.ClassUtils
Return the number of methods with a given name (with any argument types), for the given class and/or its superclasses.
getMethodIfAvailable(Class<?>, String, Class<?>...) - Static method in class org.springframework.shell.support.util.ClassUtils
Determine whether the given class has a method with the given signature, and return it if available (else return null).
getMostSpecificMethod(Method, Class<?>) - Static method in class org.springframework.shell.support.util.ClassUtils
Given a method, which may come from an interface, and a target class used in the current reflective invocation, find the corresponding target method if there is one.
getName() - Method in class org.springframework.shell.support.util.WebXmlUtils.WebXmlParam
Returns the name of this parameter
getOptionContext() - Static method in class org.springframework.shell.core.CliOptionContext
Returns the option context for the current thread.
getOrder() - Method in class org.springframework.shell.core.Completion
 
getPackageName(Class<?>) - Static method in class org.springframework.shell.support.util.ClassUtils
Determine the name of the package of the given class: e.g.
getParser() - Method in class org.springframework.shell.core.AbstractShell
 
getParser() - Method in class org.springframework.shell.core.JLineShellComponent
 
getParseResult() - Method in class org.springframework.shell.event.ShellStatus
 
getPath(Class<?>, String) - Static method in class org.springframework.shell.support.util.FileUtils
Determines the path to the requested file, relative to the given class.
getProductName() - Method in class org.springframework.shell.core.JLineShell
get product name
getProductName() - Method in class org.springframework.shell.core.JLineShellComponent
 
getPrompt() - Method in interface org.springframework.shell.plugin.PromptProvider
Returns the prompt text.
getPrompt() - Method in class org.springframework.shell.plugin.support.DefaultPromptProvider
 
getPromptText() - Method in class org.springframework.shell.core.JLineShell
get prompt text from provider.
getPromptText() - Method in class org.springframework.shell.core.JLineShellComponent
get prompt text from provider.
getQualifiedMethodName(Method) - Static method in class org.springframework.shell.support.util.ClassUtils
Return the qualified name of the given method, consisting of fully qualified interface/class name + "." + method name.
getQualifiedName(Class<?>) - Static method in class org.springframework.shell.support.util.ClassUtils
Return the qualified name of the given class: usually simply the class name, but component type class name + "[]" for arrays.
getRemainingBuffer() - Method in class org.springframework.shell.core.MethodTarget
 
getRootElement(Class<?>, String) - Static method in class org.springframework.shell.support.util.XmlUtils
Returns the root element of the given XML file.
getShellPrompt() - Method in class org.springframework.shell.core.AbstractShell
 
getShellPrompt() - Method in interface org.springframework.shell.core.ShellPromptAccessor
 
getShellStatus() - Method in class org.springframework.shell.event.AbstractShellStatusPublisher
 
getShellStatus() - Method in interface org.springframework.shell.event.ShellStatusProvider
Returns the current shell status.
getShortName(String) - Static method in class org.springframework.shell.support.util.ClassUtils
Get the class name without the qualified package name.
getShortName(Class<?>) - Static method in class org.springframework.shell.support.util.ClassUtils
Get the class name without the qualified package name.
getShortNameAsProperty(Class<?>) - Static method in class org.springframework.shell.support.util.ClassUtils
Return the short string name of a Java class in uncapitalized JavaBeans property format.
getSimpleParser() - Method in class org.springframework.shell.core.JLineShellComponent
 
getSimpleParserContext() - Static method in class org.springframework.shell.core.CliSimpleParserContext
 
getSourceClassName() - Method in class org.springframework.shell.support.logging.LoggingOutputStream
 
getStartupNotifications() - Method in class org.springframework.shell.core.JLineShell
 
getStartupNotifications() - Method in class org.springframework.shell.core.JLineShellComponent
 
getStaticMethod(Class<?>, String, Class<?>...) - Static method in class org.springframework.shell.support.util.ClassUtils
Return a public static method of a class.
getStatus() - Method in class org.springframework.shell.event.ShellStatus
 
getSystemDependentPath(String...) - Static method in class org.springframework.shell.support.util.FileUtils
Returns an operating-system-dependent path consisting of the given elements, separated by File.separator.
getSystemDependentPath(Collection<String>) - Static method in class org.springframework.shell.support.util.FileUtils
Returns an operating-system-dependent path consisting of the given elements, separated by File.separator.
getTarget() - Method in class org.springframework.shell.core.MethodTarget
 
getTargetHandler() - Method in class org.springframework.shell.support.logging.DeferredLogHandler
 
getTemplate(Class<?>, String) - Static method in class org.springframework.shell.support.util.TemplateUtils
Deprecated. use FileUtils.getInputStream(Class, String) instead
getTemplatePath(Class<?>, String) - Static method in class org.springframework.shell.support.util.TemplateUtils
Deprecated. use FileUtils.getPath(Class, String) instead
getTextContent(Node, String) - Static method in class org.springframework.shell.support.util.DomUtils
Returns the text content of the given Node, null safe.
getTextContent(String, Element) - Static method in class org.springframework.shell.support.util.XmlUtils
 
getTextContent(String, Element, String) - Static method in class org.springframework.shell.support.util.XmlUtils
 
getTextValue(Element) - Static method in class org.springframework.shell.support.util.DomUtils
Extract the text value from the given DOM element, ignoring XML comments.
getUrlPatterns() - Method in class org.springframework.shell.support.util.WebXmlUtils.WebResourceCollection
 
getUserClass(Object) - Static method in class org.springframework.shell.support.util.ClassUtils
Return the user-defined class for the given instance: usually simply the class of the given instance, but the original class in case of a CGLIB-generated subclass.
getUserClass(Class<?>) - Static method in class org.springframework.shell.support.util.ClassUtils
Return the user-defined class for the given class: usually simply the given class, but the original class in case of a CGLIB-generated subclass.
getValue() - Method in class org.springframework.shell.core.Completion
 
getValue() - Method in class org.springframework.shell.support.util.Pair
Returns the value
getValues() - Method in class org.springframework.shell.support.util.PairList
Returns the values of each Pair in this list
getValueStyler() - Method in class org.springframework.shell.support.style.DefaultToStringStyler
Return the ValueStyler used by this ToStringStyler.
getVersion() - Method in class org.springframework.shell.core.JLineShell
get version information
getVersion() - Method in class org.springframework.shell.core.JLineShellComponent
 
getVersion() - Method in interface org.springframework.shell.plugin.BannerProvider
Returns the associated version.
getVersion() - Method in class org.springframework.shell.plugin.support.DefaultBannerProvider
 
getWebResourceName() - Method in class org.springframework.shell.support.util.WebXmlUtils.WebResourceCollection
 
getWelcomeMessage() - Method in class org.springframework.shell.core.JLineShellComponent
get the welcome message at start.
getWelcomeMessage() - Method in interface org.springframework.shell.plugin.BannerProvider
Returns the welcome message.
getWelcomeMessage() - Method in class org.springframework.shell.plugin.support.DefaultBannerProvider
 
getWorkingDirectory() - Method in class org.springframework.shell.converters.FileConverter
 
getWorkingDirectory() - Method in class org.springframework.shell.converters.SimpleFileConverter
 
GZIP - Static variable in class org.springframework.shell.support.util.Base64
Specify that data should be gzip-compressed in second bit.

H

handleExecutionResult(Object) - Method in class org.springframework.shell.core.AbstractShell
Handles the result of execution of a command.
handleInvocationTargetException(InvocationTargetException) - Static method in class org.springframework.shell.support.util.ReflectionUtils
Handle the given invocation target exception.
handleReflectionException(Exception) - Static method in class org.springframework.shell.support.util.ReflectionUtils
Handle the given reflection exception.
HandlerUtils - Class in org.springframework.shell.support.logging
Utility methods for dealing with Handler objects.
HandlerUtils() - Constructor for class org.springframework.shell.support.logging.HandlerUtils
 
hasAtLeastOneMethodWithName(Class<?>, String) - Static method in class org.springframework.shell.support.util.ClassUtils
Does the given class or one of its superclasses at least have one or more methods with the supplied name (with any argument types)?
hasConstructor(Class<?>, Class<?>...) - Static method in class org.springframework.shell.support.util.ClassUtils
Determine whether the given class has a public constructor with the given signature.
hashCode() - Method in class org.springframework.shell.core.Completion
 
hashCode() - Method in class org.springframework.shell.core.MethodTarget
 
hashCode() - Method in class org.springframework.shell.event.ParseResult
 
hashCode() - Method in class org.springframework.shell.event.ShellStatus
 
hashCode(boolean) - Static method in class org.springframework.shell.support.util.ObjectUtils
Returns the hash code of the given boolean value.
hashCode(double) - Static method in class org.springframework.shell.support.util.ObjectUtils
Return the same value as Double.hashCode().
hashCode(float) - Static method in class org.springframework.shell.support.util.ObjectUtils
Return the same value as Float.hashCode().
hashCode(long) - Static method in class org.springframework.shell.support.util.ObjectUtils
Return the same value as Long.hashCode().
hashCode() - Method in class org.springframework.shell.support.util.Pair
 
hasLength(String, String) - Static method in class org.springframework.shell.support.util.Assert
Assert that the given String is not empty; that is, it must not be null and not the empty String.
hasLength(String) - Static method in class org.springframework.shell.support.util.Assert
Assert that the given String is not empty; that is, it must not be null and not the empty String.
hasLength(CharSequence) - Static method in class org.springframework.shell.support.util.StringUtils
Check that the given CharSequence is neither null nor of length 0.
hasLength(String) - Static method in class org.springframework.shell.support.util.StringUtils
Check that the given String is neither null nor of length 0.
hasMethod(Class<?>, String, Class<?>...) - Static method in class org.springframework.shell.support.util.ClassUtils
Determine whether the given class has a method with the given signature.
hasText(String, String) - Static method in class org.springframework.shell.support.util.Assert
Assert that the given String has valid text content; that is, it must not be null and must contain at least one non-whitespace character.
hasText(String) - Static method in class org.springframework.shell.support.util.Assert
Assert that the given String has valid text content; that is, it must not be null and must contain at least one non-whitespace character.
hasText(CharSequence) - Static method in class org.springframework.shell.support.util.StringUtils
Check whether the given CharSequence has actual text.
hasText(String) - Static method in class org.springframework.shell.support.util.StringUtils
Check whether the given String has actual text.
hasUniqueObject(Collection<?>) - Static method in class org.springframework.shell.support.util.CollectionUtils
Determine whether the given Collection only contains a single unique object.
HelpCommands - Class in org.springframework.shell.commands
Provides a listing of commands known to the shell.
HelpCommands() - Constructor for class org.springframework.shell.commands.HelpCommands
 
helpReferenceGuide() - Method in class org.springframework.shell.core.SimpleParser
 
HexUtils - Class in org.springframework.shell.support.util
Encodes a given byte array as hex.
HexUtils() - Constructor for class org.springframework.shell.support.util.HexUtils
 
hint(String) - Method in class org.springframework.shell.commands.HintCommands
 
hint(String) - Method in interface org.springframework.shell.commands.HintOperations
 
hint(String) - Method in class org.springframework.shell.commands.ResourceBundleHintOperations
 
HintCommands - Class in org.springframework.shell.commands
 
HintCommands() - Constructor for class org.springframework.shell.commands.HintCommands
 
HintConverter - Class in org.springframework.shell.commands
Converter for String that understands the "topics" option context.
HintConverter() - Constructor for class org.springframework.shell.commands.HintConverter
 
HintOperations - Interface in org.springframework.shell.commands
 
HistoryFileNameProvider - Interface in org.springframework.shell.plugin
History file name provider.

I

identityToString(Object) - Static method in class org.springframework.shell.support.util.ObjectUtils
Return a String representation of an object's overall identity.
IdeTerminal - Class in org.springframework.shell.core
Terminal used for debugging inside an IDE.
IdeTerminal() - Constructor for class org.springframework.shell.core.IdeTerminal
 
inBlockComment - Variable in class org.springframework.shell.core.AbstractShell
 
include(T) - Method in interface org.springframework.shell.support.util.Filter
Indicates whether to include the given instance in the filtered results
inlineComment() - Method in class org.springframework.shell.core.AbstractShell
 
IntegerConverter - Class in org.springframework.shell.converters
Converter for Integer.
IntegerConverter() - Constructor for class org.springframework.shell.converters.IntegerConverter
 
invokeJdbcMethod(Method, Object) - Static method in class org.springframework.shell.support.util.ReflectionUtils
Invoke the specified JDBC API Method against the supplied target object with no arguments.
invokeJdbcMethod(Method, Object, Object[]) - Static method in class org.springframework.shell.support.util.ReflectionUtils
Invoke the specified JDBC API Method against the supplied target object with the supplied arguments.
invokeMethod(Method, Object) - Static method in class org.springframework.shell.support.util.ReflectionUtils
Invoke the specified Method against the supplied target object with no arguments.
invokeMethod(Method, Object, Object[]) - Static method in class org.springframework.shell.support.util.ReflectionUtils
Invoke the specified Method against the supplied target object with the supplied arguments.
IOUtils - Class in org.springframework.shell.support.util
Static helper methods relating to I/O.
isANSISupported() - Method in class org.springframework.shell.core.IdeTerminal
 
isAssignable(Class<?>, Class<?>) - Static method in class org.springframework.shell.support.util.Assert
Assert that superType.isAssignableFrom(subType) is true.
isAssignable(Class<?>, Class<?>, String) - Static method in class org.springframework.shell.support.util.Assert
Assert that superType.isAssignableFrom(subType) is true.
isAssignable(Class<?>, Class<?>) - Static method in class org.springframework.shell.support.util.ClassUtils
Check if the right-hand side type may be assigned to the left-hand side type, assuming setting by reflection.
isAssignableValue(Class<?>, Object) - Static method in class org.springframework.shell.support.util.ClassUtils
Determine if the given type is assignable from the given value, assuming setting by reflection.
isBlank(String) - Static method in class org.springframework.shell.support.util.StringUtils
Indicates whether the given text is blank.
isCacheSafe(Class<?>, ClassLoader) - Static method in class org.springframework.shell.support.util.ClassUtils
Check whether the given class is cache-safe in the given context, i.e. whether it is loaded by the given ClassLoader or a parent of it.
isCheckedException(Throwable) - Static method in class org.springframework.shell.support.util.ObjectUtils
Return whether the given throwable is a checked exception: that is, neither a RuntimeException nor an Error.
isCompatibleWithThrowsClause(Throwable, Class<?>...) - Static method in class org.springframework.shell.support.util.ObjectUtils
Check whether the given exception is compatible with the exceptions declared in a throws clause.
isDevelopmentMode() - Method in class org.springframework.shell.core.JLineShell
 
isDevelopmentMode() - Method in interface org.springframework.shell.core.Shell
 
isEmpty(Collection<?>) - Static method in class org.springframework.shell.support.util.CollectionUtils
Return true if the supplied Collection is null or empty.
isEmpty(Map<?, ?>) - Static method in class org.springframework.shell.support.util.CollectionUtils
Return true if the supplied Map is null or empty.
isEmpty(Object[]) - Static method in class org.springframework.shell.support.util.ObjectUtils
Return whether the given array is empty: that is, null or of zero length.
isEqualsMethod(Method) - Static method in class org.springframework.shell.support.util.ReflectionUtils
Determine whether the given method is an "equals" method.
isHashCodeMethod(Method) - Static method in class org.springframework.shell.support.util.ReflectionUtils
Determine whether the given method is a "hashCode" method.
isInstanceOf(Class<?>, Object) - Static method in class org.springframework.shell.support.util.Assert
Assert that the provided object is an instance of the provided class.
isInstanceOf(Class<?>, Object, String) - Static method in class org.springframework.shell.support.util.Assert
Assert that the provided object is an instance of the provided class.
isNull(Object, String) - Static method in class org.springframework.shell.support.util.Assert
Assert that an object is null .
isNull(Object) - Static method in class org.springframework.shell.support.util.Assert
Assert that an object is null .
isPattern(String) - Method in class org.springframework.shell.support.util.AntPathMatcher
 
isPattern(String) - Method in interface org.springframework.shell.support.util.PathMatcher
Does the given path represent a pattern that can be matched by an implementation of this interface?
isPresent(String) - Static method in class org.springframework.shell.support.util.ClassUtils
Deprecated. as of Spring 2.5, in favor of ClassUtils.isPresent(String, ClassLoader)
isPresent(String, ClassLoader) - Static method in class org.springframework.shell.support.util.ClassUtils
Determine whether the Class identified by the supplied name is present and can be loaded.
isPrimitiveArray(Class<?>) - Static method in class org.springframework.shell.support.util.ClassUtils
Check if the given class represents an array of primitives, i.e. boolean, byte, char, short, int, long, float, or double.
isPrimitiveOrWrapper(Class<?>) - Static method in class org.springframework.shell.support.util.ClassUtils
Check if the given class represents a primitive (i.e. boolean, byte, char, short, int, long, float, or double) or a primitive wrapper (i.e.
isPrimitiveWrapper(Class<?>) - Static method in class org.springframework.shell.support.util.ClassUtils
Check if the given class represents a primitive wrapper, i.e.
isPrimitiveWrapperArray(Class<?>) - Static method in class org.springframework.shell.support.util.ClassUtils
Check if the given class represents an array of primitive wrappers, i.e.
isPublicStaticFinal(Field) - Static method in class org.springframework.shell.support.util.ReflectionUtils
Determine whether the given field is a "public static final" constant.
isReadyForCommands() - Method in interface org.springframework.shell.core.ExecutionStrategy
Indicates commands are able to be presented.
isReadyForCommands() - Method in class org.springframework.shell.core.SimpleExecutionStrategy
 
isRunning() - Method in class org.springframework.shell.core.JLineShellComponent
 
isSpace(char) - Static method in class org.springframework.shell.support.util.NaturalOrderComparator
Indicates whether the given character is whitespace
isSuppressDuplicateMessages() - Static method in class org.springframework.shell.core.JLineLogHandler
 
isToStringMethod(Method) - Static method in class org.springframework.shell.support.util.ReflectionUtils
Determine whether the given method is a "toString" method.
isTrue(boolean, String) - Static method in class org.springframework.shell.support.util.Assert
Assert a boolean expression, throwing IllegalArgumentException if the test result is false.
isTrue(boolean) - Static method in class org.springframework.shell.support.util.Assert
Assert a boolean expression, throwing IllegalArgumentException if the test result is false.
isVisible(Class<?>, ClassLoader) - Static method in class org.springframework.shell.support.util.ClassUtils
Check whether the given class is visible in the given ClassLoader.
isWindows() - Static method in class org.springframework.shell.support.util.OsUtils
 

J

JLineCompletorAdapter - Class in org.springframework.shell.core
An implementation of JLine's Completor interface that delegates to a Parser.
JLineCompletorAdapter(Parser) - Constructor for class org.springframework.shell.core.JLineCompletorAdapter
 
JLineLogHandler - Class in org.springframework.shell.core
JDK logging Handler that emits log messages to a JLine ConsoleReader.
JLineLogHandler(ConsoleReader, ShellPromptAccessor) - Constructor for class org.springframework.shell.core.JLineLogHandler
 
JLineShell - Class in org.springframework.shell.core
Uses the feature-rich JLine library to provide an interactive shell.
JLineShell() - Constructor for class org.springframework.shell.core.JLineShell
 
JLineShellComponent - Class in org.springframework.shell.core
Launcher for JLineShell.
JLineShellComponent() - Constructor for class org.springframework.shell.core.JLineShellComponent
 
JVM_TERMINATED_EXIT - Static variable in class org.springframework.shell.core.ExitShellRequest
 

L

LINE_SEPARATOR - Static variable in class org.springframework.shell.support.util.StringUtils
The platform-specific line separator.
LocaleConverter - Class in org.springframework.shell.converters
Converter for Locale.
LocaleConverter() - Constructor for class org.springframework.shell.converters.LocaleConverter
 
logCommandIfRequired(String, boolean) - Method in class org.springframework.shell.core.AbstractShell
Allows a subclass to log the execution of a well-formed command.
logCommandToOutput(String) - Method in class org.springframework.shell.core.AbstractShell
Allows a subclass to actually write the resulting logged command to some form of output.
logCommandToOutput(String) - Method in class org.springframework.shell.core.JLineShell
 
logger - Variable in class org.springframework.shell.core.AbstractShell
 
LOGGER - Static variable in class org.springframework.shell.support.logging.LoggingOutputStream
 
LoggingOutputStream - Class in org.springframework.shell.support.logging
Wraps an OutputStream and automatically passes each line to the Logger when OutputStream.flush() or OutputStream.close() is called.
LoggingOutputStream(Level) - Constructor for class org.springframework.shell.support.logging.LoggingOutputStream
Constructor
LongConverter - Class in org.springframework.shell.converters
Converter for Long.
LongConverter() - Constructor for class org.springframework.shell.converters.LongConverter
 

M

main(String[]) - Static method in class org.springframework.shell.Bootstrap
 
makeAccessible(Field) - Static method in class org.springframework.shell.support.util.ReflectionUtils
Make the given field accessible, explicitly setting it accessible if necessary.
makeAccessible(Method) - Static method in class org.springframework.shell.support.util.ReflectionUtils
Make the given method accessible, explicitly setting it accessible if necessary.
makeAccessible(Constructor<?>) - Static method in class org.springframework.shell.support.util.ReflectionUtils
Make the given constructor accessible, explicitly setting it accessible if necessary.
match(String, String) - Method in class org.springframework.shell.support.util.AntPathMatcher
 
match(String, String) - Method in interface org.springframework.shell.support.util.PathMatcher
Match the given path against the given pattern, according to this PathMatcher's matching strategy.
matches(Field) - Method in interface org.springframework.shell.support.util.ReflectionUtils.FieldFilter
Determine whether the given field matches.
matches(Method) - Method in interface org.springframework.shell.support.util.ReflectionUtils.MethodFilter
Determine whether the given method matches.
matchesAntPath(String, String) - Static method in class org.springframework.shell.support.util.FileUtils
Indicates whether the given canonical path matches the given Ant-style pattern
matchesTypeName(Class<?>, String) - Static method in class org.springframework.shell.support.util.ClassUtils
Check whether the given class matches the user-specified type name.
matchStart(String, String) - Method in class org.springframework.shell.support.util.AntPathMatcher
 
matchStart(String, String) - Method in interface org.springframework.shell.support.util.PathMatcher
Match the given path against the corresponding part of the given pattern, according to this PathMatcher's matching strategy.
MathUtils - Class in org.springframework.shell.support.util
A class which contains a number of number manipulation operations
MathUtils() - Constructor for class org.springframework.shell.support.util.MathUtils
 
max(Number...) - Static method in class org.springframework.shell.support.util.NumberUtils
Returns the maximum value in the array.
mergeArrayIntoCollection(Object, Collection<Object>) - Static method in class org.springframework.shell.support.util.CollectionUtils
Merge the given array into the given Collection.
mergePropertiesIntoMap(Properties, Map<String, String>) - Static method in class org.springframework.shell.support.util.CollectionUtils
Merge the given Properties instance into the given Map, copying all properties (key-value pairs) over.
mergeStringArrays(String[], String[]) - Static method in class org.springframework.shell.support.util.StringUtils
Merge the given String arrays into one, with overlapping array elements only included once.
MessageDisplayUtils - Class in org.springframework.shell.support.logging
Retrieves text files from the classloader and displays them on-screen.
MessageDisplayUtils() - Constructor for class org.springframework.shell.support.logging.MessageDisplayUtils
 
MethodTarget - Class in org.springframework.shell.core
A method that can be executed via a shell command.
MethodTarget(Method, Object) - Constructor for class org.springframework.shell.core.MethodTarget
Constructor for a null remainingBuffer and key
MethodTarget(Method, Object, String, String) - Constructor for class org.springframework.shell.core.MethodTarget
Constructor that allows all fields to be set
min(Number...) - Static method in class org.springframework.shell.support.util.NumberUtils
Returns the minimum value in the array.

N

name() - Method in interface org.springframework.shell.plugin.PluginProvider
Returns the name of the plugin.
name() - Method in class org.springframework.shell.plugin.support.DefaultBannerProvider
 
name() - Method in class org.springframework.shell.plugin.support.DefaultHistoryFileNameProvider
 
name() - Method in class org.springframework.shell.plugin.support.DefaultPromptProvider
 
NaturalOrderComparator<E> - Class in org.springframework.shell.support.util
NaturalOrderComparator.java -- Perform natural order comparisons of strings in Java.
NaturalOrderComparator() - Constructor for class org.springframework.shell.support.util.NaturalOrderComparator
 
NO_OPTIONS - Static variable in class org.springframework.shell.support.util.Base64
No options specified.
nodeNameEquals(Node, String) - Static method in class org.springframework.shell.support.util.DomUtils
Namespace-aware equals comparison.
nodeToString(Node) - Static method in class org.springframework.shell.support.util.XmlUtils
Converts a node to an XML string
noNullElements(Object[], String) - Static method in class org.springframework.shell.support.util.Assert
Assert that an array has no null elements.
noNullElements(Object[]) - Static method in class org.springframework.shell.support.util.Assert
Assert that an array has no null elements.
NORMAL_EXIT - Static variable in class org.springframework.shell.core.ExitShellRequest
 
notEmpty(Object[], String) - Static method in class org.springframework.shell.support.util.Assert
Assert that an array has elements; that is, it must not be null and must have at least one element.
notEmpty(Object[]) - Static method in class org.springframework.shell.support.util.Assert
Assert that an array has elements; that is, it must not be null and must have at least one element.
notEmpty(Collection<?>, String) - Static method in class org.springframework.shell.support.util.Assert
Assert that a collection has elements; that is, it must not be null and must have at least one element.
notEmpty(Collection<?>) - Static method in class org.springframework.shell.support.util.Assert
Assert that a collection has elements; that is, it must not be null and must have at least one element.
notEmpty(Map<?, ?>, String) - Static method in class org.springframework.shell.support.util.Assert
Assert that a Map has entries; that is, it must not be null and must have at least one entry.
notEmpty(Map<?, ?>) - Static method in class org.springframework.shell.support.util.Assert
Assert that a Map has entries; that is, it must not be null and must have at least one entry.
notNull(Object, String) - Static method in class org.springframework.shell.support.util.Assert
Assert that an object is not null .
notNull(Object) - Static method in class org.springframework.shell.support.util.Assert
Assert that an object is not null .
nullSafeClassName(Object) - Static method in class org.springframework.shell.support.util.ObjectUtils
Determine the class name for the given object.
nullSafeComparison(Comparable<T>, T) - Static method in class org.springframework.shell.support.util.ObjectUtils
Compares the two given objects, with null equivalent to null and null "less than" any non-null instance.
nullSafeEquals(Object, Object) - Static method in class org.springframework.shell.support.util.ObjectUtils
Determine if the given objects are equal, returning true if both are null or false if only one is null.
nullSafeHashCode(Object) - Static method in class org.springframework.shell.support.util.ObjectUtils
Return as hash code for the given object; typically the value of Object.hashCode().
nullSafeHashCode(Object...) - Static method in class org.springframework.shell.support.util.ObjectUtils
Return a hash code based on the contents of the specified array.
nullSafeHashCode(boolean...) - Static method in class org.springframework.shell.support.util.ObjectUtils
Return a hash code based on the contents of the specified array.
nullSafeHashCode(byte...) - Static method in class org.springframework.shell.support.util.ObjectUtils
Return a hash code based on the contents of the specified array.
nullSafeHashCode(char...) - Static method in class org.springframework.shell.support.util.ObjectUtils
Return a hash code based on the contents of the specified array.
nullSafeHashCode(double...) - Static method in class org.springframework.shell.support.util.ObjectUtils
Return a hash code based on the contents of the specified array.
nullSafeHashCode(float...) - Static method in class org.springframework.shell.support.util.ObjectUtils
Return a hash code based on the contents of the specified array.
nullSafeHashCode(int...) - Static method in class org.springframework.shell.support.util.ObjectUtils
Return a hash code based on the contents of the specified array.
nullSafeHashCode(long...) - Static method in class org.springframework.shell.support.util.ObjectUtils
Return a hash code based on the contents of the specified array.
nullSafeHashCode(short...) - Static method in class org.springframework.shell.support.util.ObjectUtils
Return a hash code based on the contents of the specified array.
nullSafeToString(Object) - Static method in class org.springframework.shell.support.util.ObjectUtils
Return a String representation of the specified Object.
nullSafeToString(Object...) - Static method in class org.springframework.shell.support.util.ObjectUtils
Return a String representation of the contents of the specified array.
nullSafeToString(boolean...) - Static method in class org.springframework.shell.support.util.ObjectUtils
Return a String representation of the contents of the specified array.
nullSafeToString(byte...) - Static method in class org.springframework.shell.support.util.ObjectUtils
Return a String representation of the contents of the specified array.
nullSafeToString(char...) - Static method in class org.springframework.shell.support.util.ObjectUtils
Return a String representation of the contents of the specified array.
nullSafeToString(double...) - Static method in class org.springframework.shell.support.util.ObjectUtils
Return a String representation of the contents of the specified array.
nullSafeToString(float...) - Static method in class org.springframework.shell.support.util.ObjectUtils
Return a String representation of the contents of the specified array.
nullSafeToString(int...) - Static method in class org.springframework.shell.support.util.ObjectUtils
Return a String representation of the contents of the specified array.
nullSafeToString(long...) - Static method in class org.springframework.shell.support.util.ObjectUtils
Return a String representation of the contents of the specified array.
nullSafeToString(short...) - Static method in class org.springframework.shell.support.util.ObjectUtils
Return a String representation of the contents of the specified array.
NumberUtils - Class in org.springframework.shell.support.util
Provides extra functionality for Java Number classes.

O

ObjectUtils - Class in org.springframework.shell.support.util
Miscellaneous object utility methods.
obtainHelp(String) - Method in class org.springframework.shell.commands.HelpCommands
 
obtainHelp(String) - Method in class org.springframework.shell.core.SimpleParser
 
onShellStatusChange(ShellStatus, ShellStatus) - Method in interface org.springframework.shell.event.ShellStatusListener
Invoked by the shell to report a new status.
ORDERED - Static variable in class org.springframework.shell.support.util.Base64
Encode using the special "ordered" dialect of Base64 described here: http://www.faqs.org/qa/rfcc-1940.html.
org.springframework.shell - package org.springframework.shell
 
org.springframework.shell.commands - package org.springframework.shell.commands
 
org.springframework.shell.converters - package org.springframework.shell.converters
 
org.springframework.shell.core - package org.springframework.shell.core
 
org.springframework.shell.core.annotation - package org.springframework.shell.core.annotation
 
org.springframework.shell.event - package org.springframework.shell.event
 
org.springframework.shell.plugin - package org.springframework.shell.plugin
 
org.springframework.shell.plugin.support - package org.springframework.shell.plugin.support
 
org.springframework.shell.support.logging - package org.springframework.shell.support.logging
 
org.springframework.shell.support.style - package org.springframework.shell.support.style
 
org.springframework.shell.support.util - package org.springframework.shell.support.util
 
OsCommands - Class in org.springframework.shell.commands
Command type to allow execution of native OS commands from the Spring Roo shell.
OsCommands() - Constructor for class org.springframework.shell.commands.OsCommands
 
OsOperations - Interface in org.springframework.shell.commands
Operations type to allow execution of native OS commands from the Spring Roo shell.
OsOperationsImpl - Class in org.springframework.shell.commands
Implementation of OsOperations interface.
OsOperationsImpl() - Constructor for class org.springframework.shell.commands.OsOperationsImpl
 
OsUtils - Class in org.springframework.shell.support.util
Utilities for handling OS-specific behavior.
OsUtils() - Constructor for class org.springframework.shell.support.util.OsUtils
 
overrideThreadContextClassLoader(ClassLoader) - Static method in class org.springframework.shell.support.util.ClassUtils
Override the thread context ClassLoader with the environment's bean ClassLoader if necessary, i.e. if the bean ClassLoader is not equivalent to the thread context ClassLoader already.

P

padLeft(String, int, char) - Static method in class org.springframework.shell.support.util.StringUtils
Left pads the presented string with the delim character.
padRight(String, int, char) - Static method in class org.springframework.shell.support.util.StringUtils
Right pads the presented string with the delim character.
Pair<K,V> - Class in org.springframework.shell.support.util
A pair with a key of type "K" and a value of type "V".
Pair(K, V) - Constructor for class org.springframework.shell.support.util.Pair
Constructor
PairList<K,V> - Class in org.springframework.shell.support.util
A List of Pairs.
PairList(Pair<K, V>...) - Constructor for class org.springframework.shell.support.util.PairList
Returns the given array of pairs as a modifiable list
PairList(List<? extends K>, List<? extends V>) - Constructor for class org.springframework.shell.support.util.PairList
Constructor for building a list of the given key-value pairs
PairList() - Constructor for class org.springframework.shell.support.util.PairList
Constructor for an empty list of pairs
parse(String) - Method in interface org.springframework.shell.core.Parser
 
parse(String) - Method in class org.springframework.shell.core.SimpleParser
 
parseCommandLine(String[]) - Static method in class org.springframework.shell.SimpleShellCommandLineOptions
 
parseLocaleString(String) - Static method in class org.springframework.shell.support.util.StringUtils
Parse the given localeString into a Locale.
Parser - Interface in org.springframework.shell.core
Interface for SimpleParser.
ParseResult - Class in org.springframework.shell.event
Immutable representation of the outcome of parsing a given shell line.
ParseResult(Method, Object, Object[]) - Constructor for class org.springframework.shell.event.ParseResult
 
ParserUtils - Class in org.springframework.shell.core
Utilities for parsing.
pathEquals(String, String) - Static method in class org.springframework.shell.support.util.StringUtils
Compare two paths after normalization of them.
PathMatcher - Interface in org.springframework.shell.support.util
Strategy interface for String-based path matching.
PluginProvider - Interface in org.springframework.shell.plugin
Generic plugin provider.
populate(List<Completion>, String, String, String) - Method in class org.springframework.shell.converters.FileConverter
 
populate(Collection<T>, Collection<? extends T>) - Static method in class org.springframework.shell.support.util.CollectionUtils
Populates the given collection by replacing any existing contents with the given elements, in a null-safe way.
prefix(String, String) - Static method in class org.springframework.shell.support.util.StringUtils
Prefixes the given string with the given prefix, if it's not already.
printBannerAndWelcome() - Method in class org.springframework.shell.core.JLineShell
 
printBannerAndWelcome() - Method in class org.springframework.shell.core.JLineShellComponent
 
prohibitRedraw() - Static method in class org.springframework.shell.core.JLineLogHandler
 
promptLoop() - Method in class org.springframework.shell.core.JLineShell
 
promptLoop() - Method in interface org.springframework.shell.core.Shell
Presents a console prompt and allows the user to interact with the shell.
PromptProvider - Interface in org.springframework.shell.plugin
Shell prompt provider.
props() - Method in class org.springframework.shell.core.AbstractShell
 
publish(LogRecord) - Method in class org.springframework.shell.core.JLineLogHandler
 
publish(LogRecord) - Method in class org.springframework.shell.support.logging.DeferredLogHandler
Stores the log record internally.

Q

quit() - Method in class org.springframework.shell.commands.EssentialCommands
 
quote(String) - Static method in class org.springframework.shell.support.util.StringUtils
Quote the given String with single quotes.
quoteIfString(Object) - Static method in class org.springframework.shell.support.util.StringUtils
Turn the given Object into a String with single quotes if it is a String; keeping the Object as-is else.

R

read() - Method in class org.springframework.shell.support.util.Base64.InputStream
Reads enough of the input stream to convert to/from Base64 and returns the next byte.
read(byte[], int, int) - Method in class org.springframework.shell.support.util.Base64.InputStream
Calls Base64.InputStream.read() repeatedly until the end of stream is reached or len bytes are read.
read(File) - Static method in class org.springframework.shell.support.util.FileUtils
Returns the contents of the given File as a String.
reader - Variable in class org.springframework.shell.core.JLineShell
 
readXml(InputStream) - Static method in class org.springframework.shell.support.util.XmlUtils
Read an XML document from the supplied input stream and return a document.
ReflectionUtils - Class in org.springframework.shell.support.util
Simple utility class for working with the reflection API and handling reflection exceptions.
ReflectionUtils() - Constructor for class org.springframework.shell.support.util.ReflectionUtils
 
ReflectionUtils.FieldCallback - Interface in org.springframework.shell.support.util
Callback interface invoked on each field in the hierarchy.
ReflectionUtils.FieldFilter - Interface in org.springframework.shell.support.util
Callback optionally used to filter fields to be operated on by a field callback.
ReflectionUtils.MethodCallback - Interface in org.springframework.shell.support.util
Action to take on each method.
ReflectionUtils.MethodFilter - Interface in org.springframework.shell.support.util
Callback optionally used to method fields to be operated on by a method callback.
registerTargetHandler(Logger, Handler) - Static method in class org.springframework.shell.support.logging.HandlerUtils
Registers the presented target Handler against any DeferredLogHandler encountered in the presented Logger.
remove(Class<?>) - Method in interface org.springframework.shell.converters.StaticFieldConverter
 
remove(Class<?>) - Method in class org.springframework.shell.converters.StaticFieldConverterImpl
 
remove(CommandMarker) - Method in class org.springframework.shell.core.SimpleParser
 
remove(Converter<?>) - Method in class org.springframework.shell.core.SimpleParser
 
removeDuplicateStrings(String[]) - Static method in class org.springframework.shell.support.util.StringUtils
Remove duplicate Strings from the given array.
removeElements(String, Element) - Static method in class org.springframework.shell.support.util.DomUtils
Removes any elements matching the given XPath expression, relative to the given Element
removeLeadingAndTrailingSeparators(String) - Static method in class org.springframework.shell.support.util.FileUtils
Removes any leading or trailing File.separators from the given path.
removePrefix(String, String) - Static method in class org.springframework.shell.support.util.StringUtils
Removes the given prefix from the given string, if it exists
removeShellStatusListener(ShellStatusListener) - Method in class org.springframework.shell.event.AbstractShellStatusPublisher
 
removeShellStatusListener(ShellStatusListener) - Method in interface org.springframework.shell.event.ShellStatusProvider
Removes an existing status listener.
removeSuffix(String, String) - Static method in class org.springframework.shell.support.util.StringUtils
Removes the given suffix from the given string, if it exists
removeTextNodes(Node) - Static method in class org.springframework.shell.support.util.DomUtils
Removes empty text nodes from the specified node.
removeTextNodes(Node) - Static method in class org.springframework.shell.support.util.XmlUtils
Deprecated. use DomUtils.removeTextNodes(Node) instead
removeTrailingSeparator(String) - Static method in class org.springframework.shell.support.util.FileUtils
Removes any trailing File.separators from the given path
repeat(String, int) - Static method in class org.springframework.shell.support.util.StringUtils
Returns the given string repeated the given number of times
replace(String, String, String) - Static method in class org.springframework.shell.support.util.StringUtils
Replaces all occurrences of one string within another.
replaceFirst(String, String, String) - Static method in class org.springframework.shell.support.util.StringUtils
Replaces the first occurrence of the given substring in the given string.
resetMessageTracking() - Static method in class org.springframework.shell.core.JLineLogHandler
 
resetOptionContext() - Static method in class org.springframework.shell.core.CliOptionContext
Resets the option context for the current thread.
resetSimpleParserContext() - Static method in class org.springframework.shell.core.CliSimpleParserContext
 
resolveClassName(String, ClassLoader) - Static method in class org.springframework.shell.support.util.ClassUtils
Resolve the given class name into a Class instance.
resolvePrimitiveClassName(String) - Static method in class org.springframework.shell.support.util.ClassUtils
Resolve the given class name as primitive class, if appropriate, according to the JVM's naming rules for primitive classes.
resolvePrimitiveIfNecessary(Class<?>) - Static method in class org.springframework.shell.support.util.ClassUtils
Resolve the given class if it is a primitive class, returning the corresponding primitive wrapper type instead.
ResourceBundleHintOperations - Class in org.springframework.shell.commands
 
ResourceBundleHintOperations() - Constructor for class org.springframework.shell.commands.ResourceBundleHintOperations
 
resumeEncoding() - Method in class org.springframework.shell.support.util.Base64.OutputStream
Resumes encoding of the stream.
rethrowException(Throwable) - Static method in class org.springframework.shell.support.util.ReflectionUtils
Rethrow the given exception, which is presumably the target exception of an InvocationTargetException.
rethrowRuntimeException(Throwable) - Static method in class org.springframework.shell.support.util.ReflectionUtils
Rethrow the given exception, which is presumably the target exception of an InvocationTargetException.
ROO_PROMPT - Static variable in class org.springframework.shell.core.AbstractShell
 
round(double, int) - Static method in class org.springframework.shell.support.util.MathUtils
 
run(String[]) - Method in class org.springframework.shell.Bootstrap
 
run() - Method in class org.springframework.shell.core.JLineShell
 

S

script(File, boolean) - Method in class org.springframework.shell.core.AbstractShell
 
setApplicationContext(ApplicationContext) - Method in class org.springframework.shell.commands.HelpCommands
 
setApplicationContext(ApplicationContext) - Method in class org.springframework.shell.core.JLineShellComponent
 
setDescription(String, Document, String) - Static method in class org.springframework.shell.support.util.WebXmlUtils
Set the description element in the web.xml document.
setDevelopmentMode(boolean) - Method in class org.springframework.shell.core.JLineShell
 
setDevelopmentMode(boolean) - Method in interface org.springframework.shell.core.Shell
Indicates the shell should switch into a lower-level development mode.
setDisplayName(String, Document, String) - Static method in class org.springframework.shell.support.util.WebXmlUtils
Set the display-name element in the web.xml document.
setField(Field, Object, Object) - Static method in class org.springframework.shell.support.util.ReflectionUtils
Set the field represented by the supplied field object on the specified target object to the specified value.
setHistorySize(int) - Method in class org.springframework.shell.core.JLineShell
 
setIncludeThreadName(boolean) - Static method in class org.springframework.shell.core.JLineLogHandler
 
setOptionContext(String) - Static method in class org.springframework.shell.core.CliOptionContext
Stores the given option context for the current thread.
setPathSeparator(String) - Method in class org.springframework.shell.support.util.AntPathMatcher
Set the path separator to use for pattern parsing.
setPrintBanner(boolean) - Method in class org.springframework.shell.core.JLineShellComponent
 
setPromptPath(String) - Method in class org.springframework.shell.core.AbstractShell
Base implementation of the Shell.setPromptPath(String) method, designed for simple shell implementations.
setPromptPath(String, boolean) - Method in class org.springframework.shell.core.AbstractShell
Default implementation of Shell#setPromptPath(String, boolean)) method to satisfy STS compatibility.
setPromptPath(String) - Method in class org.springframework.shell.core.JLineShell
 
setPromptPath(String, boolean) - Method in class org.springframework.shell.core.JLineShell
 
setPromptPath(String) - Method in interface org.springframework.shell.core.Shell
Changes the "path" displayed in the shell prompt.
setPromptPath(String, boolean) - Method in interface org.springframework.shell.core.Shell
 
setSessionTimeout(int, Document, String) - Static method in class org.springframework.shell.support.util.WebXmlUtils
Set session timeout in web.xml document
setShellStatus(ShellStatus.Status) - Method in class org.springframework.shell.event.AbstractShellStatusPublisher
 
setShellStatus(ShellStatus.Status, String, ParseResult) - Method in class org.springframework.shell.event.AbstractShellStatusPublisher
 
setSimpleParserContext(SimpleParser) - Static method in class org.springframework.shell.core.CliSimpleParserContext
 
setSourceClassName(String) - Method in class org.springframework.shell.support.logging.LoggingOutputStream
 
setSuppressDuplicateMessages(boolean) - Static method in class org.springframework.shell.core.JLineLogHandler
 
setTargetHandler(Handler) - Method in class org.springframework.shell.support.logging.DeferredLogHandler
 
setText(String) - Method in class org.springframework.shell.support.util.XmlElementBuilder
Add text contents to the current element.
shallowCopyFieldState(Object, Object) - Static method in class org.springframework.shell.support.util.ReflectionUtils
Given the source object and the destination, which must be the same class or a subclass, copy all fields, including inherited fields.
Shell - Interface in org.springframework.shell.core
Specifies the contract for an interactive shell.
shellPrompt - Static variable in class org.springframework.shell.core.AbstractShell
 
ShellPromptAccessor - Interface in org.springframework.shell.core
Obtains the prompt used by a Shell.
shellStatus - Variable in class org.springframework.shell.event.AbstractShellStatusPublisher
 
ShellStatus - Class in org.springframework.shell.event
Represents the different states that a shell can legally be in.
ShellStatus.Status - Enum in org.springframework.shell.event
 
ShellStatusListener - Interface in org.springframework.shell.event
Implemented by classes that wish to be notified of shell status changes.
shellStatusListeners - Variable in class org.springframework.shell.event.AbstractShellStatusPublisher
 
ShellStatusProvider - Interface in org.springframework.shell.event
Implemented by shells that support the publication of shell status changes.
ShortConverter - Class in org.springframework.shell.converters
Converter for Short.
ShortConverter() - Constructor for class org.springframework.shell.converters.ShortConverter
 
SimpleExecutionStrategy - Class in org.springframework.shell.core
Simple execution strategy for invoking a target method.
SimpleExecutionStrategy() - Constructor for class org.springframework.shell.core.SimpleExecutionStrategy
 
SimpleFileConverter - Class in org.springframework.shell.converters
 
SimpleFileConverter() - Constructor for class org.springframework.shell.converters.SimpleFileConverter
 
SimpleParser - Class in org.springframework.shell.core
Default implementation of Parser.
SimpleParser() - Constructor for class org.springframework.shell.core.SimpleParser
 
SimpleShellCommandLineOptions - Class in org.springframework.shell
Used to pass in command line options to customize the shell on launch
SimpleShellCommandLineOptions() - Constructor for class org.springframework.shell.SimpleShellCommandLineOptions
 
sortStringArray(String[]) - Static method in class org.springframework.shell.support.util.StringUtils
Turn given source String array into sorted array.
split(String, String) - Static method in class org.springframework.shell.support.util.StringUtils
Split a String at the first occurrence of the delimiter.
splitArrayElementsIntoProperties(String[], String) - Static method in class org.springframework.shell.support.util.StringUtils
Take an array Strings and split each element based on the given delimiter.
splitArrayElementsIntoProperties(String[], String, String) - Static method in class org.springframework.shell.support.util.StringUtils
Take an array Strings and split each element based on the given delimiter.
start() - Method in class org.springframework.shell.core.JLineShellComponent
 
startsWithIgnoreCase(String, String) - Static method in class org.springframework.shell.support.util.StringUtils
Test if the given String starts with the specified prefix, ignoring upper/lower case.
state(boolean, String) - Static method in class org.springframework.shell.support.util.Assert
Assert a boolean expression, throwing IllegalStateException if the test result is false.
state(boolean) - Static method in class org.springframework.shell.support.util.Assert
Assert a boolean expression, throwing IllegalStateException if the test result is false.
StaticFieldConverter - Interface in org.springframework.shell.converters
Interface for adding and removing classes that provide static fields which should be made available via a Converter.
StaticFieldConverterImpl - Class in org.springframework.shell.converters
A simple Converter for those classes which provide public static fields to represent possible textual values.
StaticFieldConverterImpl() - Constructor for class org.springframework.shell.converters.StaticFieldConverterImpl
 
statusListener - Variable in class org.springframework.shell.core.JLineShell
 
stop() - Method in class org.springframework.shell.core.JLineShellComponent
 
StringConverter - Class in org.springframework.shell.converters
Converter for String.
StringConverter() - Constructor for class org.springframework.shell.converters.StringConverter
 
stringify(E) - Method in class org.springframework.shell.support.util.NaturalOrderComparator
 
stringToElement(String) - Static method in class org.springframework.shell.support.util.XmlUtils
Returns the given XML as the root Element of a new Document
StringUtils - Class in org.springframework.shell.support.util
Miscellaneous String utility methods.
stripFilenameExtension(String) - Static method in class org.springframework.shell.support.util.StringUtils
Strip the filename extension from the given path, e.g.
style(Object) - Method in class org.springframework.shell.support.style.DefaultValueStyler
 
style(Object) - Static method in class org.springframework.shell.support.style.StylerUtils
Style the specified value according to default conventions.
style(Object) - Method in interface org.springframework.shell.support.style.ValueStyler
Style the given value, returning a String representation.
styleEnd(StringBuilder, Object) - Method in class org.springframework.shell.support.style.DefaultToStringStyler
 
styleEnd(StringBuilder, Object) - Method in interface org.springframework.shell.support.style.ToStringStyler
Style a toString()'ed object after it's fields are styled.
styleField(StringBuilder, String, Object) - Method in class org.springframework.shell.support.style.DefaultToStringStyler
 
styleField(StringBuilder, String, Object) - Method in interface org.springframework.shell.support.style.ToStringStyler
Style a field value as a string.
styleFieldEnd(StringBuilder, String) - Method in class org.springframework.shell.support.style.DefaultToStringStyler
 
styleFieldSeparator(StringBuilder) - Method in class org.springframework.shell.support.style.DefaultToStringStyler
 
styleFieldSeparator(StringBuilder) - Method in interface org.springframework.shell.support.style.ToStringStyler
Style the field separator.
styleFieldStart(StringBuilder, String) - Method in class org.springframework.shell.support.style.DefaultToStringStyler
 
StylerUtils - Class in org.springframework.shell.support.style
Simple utility class to allow for convenient access to value styling logic, mainly to support descriptive logging messages.
StylerUtils() - Constructor for class org.springframework.shell.support.style.StylerUtils
 
styleStart(StringBuilder, Object) - Method in class org.springframework.shell.support.style.DefaultToStringStyler
 
styleStart(StringBuilder, Object) - Method in interface org.springframework.shell.support.style.ToStringStyler
Style a toString()'ed object before its fields are styled.
styleValue(StringBuilder, Object) - Method in class org.springframework.shell.support.style.DefaultToStringStyler
 
styleValue(StringBuilder, Object) - Method in interface org.springframework.shell.support.style.ToStringStyler
Style the given value.
substringAfterLast(String, String) - Static method in class org.springframework.shell.support.util.StringUtils
Returns the substring after the last occurrence of a separator.
substringMatch(CharSequence, int, CharSequence) - Static method in class org.springframework.shell.support.util.StringUtils
Test whether the given string matches the given substring at the given index.
suffix(String, String) - Static method in class org.springframework.shell.support.util.StringUtils
Appends the given suffix to the given string, if not already present
supports(Class<?>, String) - Method in class org.springframework.shell.commands.HintConverter
 
supports(Class<?>, String) - Method in class org.springframework.shell.converters.AvailableCommandsConverter
 
supports(Class<?>, String) - Method in class org.springframework.shell.converters.BigDecimalConverter
 
supports(Class<?>, String) - Method in class org.springframework.shell.converters.BigIntegerConverter
 
supports(Class<?>, String) - Method in class org.springframework.shell.converters.BooleanConverter
 
supports(Class<?>, String) - Method in class org.springframework.shell.converters.CharacterConverter
 
supports(Class<?>, String) - Method in class org.springframework.shell.converters.DateConverter
 
supports(Class<?>, String) - Method in class org.springframework.shell.converters.DoubleConverter
 
supports(Class<?>, String) - Method in class org.springframework.shell.converters.EnumConverter
 
supports(Class<?>, String) - Method in class org.springframework.shell.converters.FileConverter
 
supports(Class<?>, String) - Method in class org.springframework.shell.converters.FloatConverter
 
supports(Class<?>, String) - Method in class org.springframework.shell.converters.IntegerConverter
 
supports(Class<?>, String) - Method in class org.springframework.shell.converters.LocaleConverter
 
supports(Class<?>, String) - Method in class org.springframework.shell.converters.LongConverter
 
supports(Class<?>, String) - Method in class org.springframework.shell.converters.ShortConverter
 
supports(Class<?>, String) - Method in class org.springframework.shell.converters.StaticFieldConverterImpl
 
supports(Class<?>, String) - Method in class org.springframework.shell.converters.StringConverter
 
supports(Class<?>, String) - Method in interface org.springframework.shell.core.Converter
Indicates whether this converter supports the given type in the given option context
suspendEncoding() - Method in class org.springframework.shell.support.util.Base64.OutputStream
Suspends encoding of the stream.

T

TemplateUtils - Class in org.springframework.shell.support.util
Utilities for dealing with "templates", which are commonly used by ROO add-ons.
terminate() - Method in interface org.springframework.shell.core.ExecutionStrategy
Indicates the execution runtime should be terminated.
terminate() - Method in class org.springframework.shell.core.SimpleExecutionStrategy
 
toArray() - Method in class org.springframework.shell.support.util.PairList
 
toHex(byte[]) - Static method in class org.springframework.shell.support.util.HexUtils
 
tokenize(String) - Static method in class org.springframework.shell.core.ParserUtils
Converts a particular buffer into a tokenized structure.
tokenizeToStringArray(String, String) - Static method in class org.springframework.shell.support.util.StringUtils
Tokenize the given String into a String array via a StringTokenizer.
tokenizeToStringArray(String, String, boolean, boolean) - Static method in class org.springframework.shell.support.util.StringUtils
Tokenize the given String into a String array via a StringTokenizer.
toLanguageTag(Locale) - Static method in class org.springframework.shell.support.util.StringUtils
Determine the RFC 3066 compliant language tag, as used for the HTTP "Accept-Language" header.
toLowerCase(String) - Static method in class org.springframework.shell.support.util.StringUtils
Converts the given String to lowercase.
toObjectArray(Object) - Static method in class org.springframework.shell.support.util.ObjectUtils
Convert the given array (which may be a primitive array) to an object array (if necessary of primitive wrapper objects).
toString() - Method in class org.springframework.shell.core.Completion
 
toString() - Method in class org.springframework.shell.core.MethodTarget
 
toString() - Method in class org.springframework.shell.event.ParseResult
 
toString() - Method in class org.springframework.shell.support.style.ToStringCreator
Return the String representation that this ToStringCreator built.
toString(Object, String) - Static method in class org.springframework.shell.support.util.ObjectUtils
Returns the String representation of the given object, or if it's null, the given default string
toString() - Method in class org.springframework.shell.support.util.Pair
 
toStringArray(Collection<String>) - Static method in class org.springframework.shell.support.util.StringUtils
Copy the given Collection into a String array.
toStringArray(Enumeration<String>) - Static method in class org.springframework.shell.support.util.StringUtils
Copy the given Enumeration into a String array.
ToStringCreator - Class in org.springframework.shell.support.style
Utility class that builds pretty-printing toString() methods with pluggable styling conventions.
ToStringCreator(Object) - Constructor for class org.springframework.shell.support.style.ToStringCreator
Create a ToStringCreator for the given object.
ToStringCreator(Object, ValueStyler) - Constructor for class org.springframework.shell.support.style.ToStringCreator
Create a ToStringCreator for the given object, using the provided style.
ToStringCreator(Object, ToStringStyler) - Constructor for class org.springframework.shell.support.style.ToStringCreator
Create a ToStringCreator for the given object, using the provided style.
ToStringStyler - Interface in org.springframework.shell.support.style
A strategy interface for pretty-printing toString() methods.
toUpperCase(String) - Static method in class org.springframework.shell.support.util.StringUtils
Converts the given String to uppercase.
toURL(URI) - Static method in class org.springframework.shell.support.util.UrlUtils
Converts the given URI to a URL; equivalent to URI.toURL() except that it throws a runtime exception.
trimAllWhitespace(String) - Static method in class org.springframework.shell.support.util.StringUtils
Trim all whitespace from the given String: leading, trailing, and inbetween characters.
trimArrayElements(String[]) - Static method in class org.springframework.shell.support.util.StringUtils
Trim the elements of the given String array, calling String.trim() on each of them.
trimLeadingCharacter(String, char) - Static method in class org.springframework.shell.support.util.StringUtils
Trim all occurences of the supplied leading character from the given String.
trimLeadingWhitespace(String) - Static method in class org.springframework.shell.support.util.StringUtils
Trim leading whitespace from the given String.
trimToEmpty(String) - Static method in class org.springframework.shell.support.util.StringUtils
Removes leading and trailing whitespace from both ends of this String returning an empty String ("") if the String is empty after the trim or if it is null.
trimToNull(String) - Static method in class org.springframework.shell.support.util.StringUtils
Removes leading and trailing whitespace from both ends of this String returning null if the String is empty ("") after the trim or if it is null.
trimTrailingCharacter(String, char) - Static method in class org.springframework.shell.support.util.StringUtils
Trim all occurences of the supplied trailing character from the given String.
trimTrailingWhitespace(String) - Static method in class org.springframework.shell.support.util.StringUtils
Trim trailing whitespace from the given String.
trimWhitespace(String) - Static method in class org.springframework.shell.support.util.StringUtils
Trim leading and trailing whitespace from the given String.

U

uncapitalize(String) - Static method in class org.springframework.shell.support.util.StringUtils
Uncapitalize a String, changing the first letter to lower case as per Character.toLowerCase(char).
unqualify(String) - Static method in class org.springframework.shell.support.util.StringUtils
Unqualify a string qualified by a '.' dot character.
unqualify(String, char) - Static method in class org.springframework.shell.support.util.StringUtils
Unqualify a string qualified by a separator character.
URL_SAFE - Static variable in class org.springframework.shell.support.util.Base64
Encode using Base64-like encoding that is URL- and Filename-safe as described in Section 4 of RFC3548: http://www.faqs.org/rfcs/rfc3548.html.
UrlUtils - Class in org.springframework.shell.support.util
Utility methods relating to networking types such as URLs.

V

valueOf(String) - Static method in enum org.springframework.shell.event.ShellStatus.Status
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.springframework.shell.support.util.AnsiEscapeCode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.springframework.shell.support.util.WebXmlUtils.Dispatcher
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.springframework.shell.support.util.WebXmlUtils.FilterPosition
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.springframework.shell.event.ShellStatus.Status
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.springframework.shell.support.util.AnsiEscapeCode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.springframework.shell.support.util.WebXmlUtils.Dispatcher
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.springframework.shell.support.util.WebXmlUtils.FilterPosition
Returns an array containing the constants of this enum type, in the order they are declared.
ValueStyler - Interface in org.springframework.shell.support.style
Strategy that encapsulates value String styling algorithms according to Spring conventions.
version(String) - Method in class org.springframework.shell.core.AbstractShell
 
versionInfo() - Method in class org.springframework.shell.core.AbstractShell
 
versionInfo() - Static method in class org.springframework.shell.support.util.VersionUtils
Returns the full version string of the present Spring Shell codebase, or null if it cannot be determined.
VersionUtils - Class in org.springframework.shell.support.util
 
VersionUtils() - Constructor for class org.springframework.shell.support.util.VersionUtils
 

W

waitForComplete() - Method in class org.springframework.shell.core.JLineShellComponent
wait the shell command to complete by typing "quit" or "exit"
WebXmlUtils - Class in org.springframework.shell.support.util
Helper util class to allow more convenient handling of web.xml file in Web projects.
WebXmlUtils.Dispatcher - Enum in org.springframework.shell.support.util
Enum to define dispatcher
WebXmlUtils.FilterPosition - Enum in org.springframework.shell.support.util
Enum to define filter position
WebXmlUtils.WebResourceCollection - Class in org.springframework.shell.support.util
Convenience class for passing a web-resource-collection element's details
WebXmlUtils.WebResourceCollection(String, String, List<String>, List<String>) - Constructor for class org.springframework.shell.support.util.WebXmlUtils.WebResourceCollection
 
WebXmlUtils.WebXmlParam - Class in org.springframework.shell.support.util
Value object that holds init-param style information
WebXmlUtils.WebXmlParam(String, String) - Constructor for class org.springframework.shell.support.util.WebXmlUtils.WebXmlParam
Constructor
WINDOW_TITLE_SLOT - Static variable in interface org.springframework.shell.core.Shell
The slot name to use with Shell.flash(Level, String, String) if a caller wishes to modify the window title.
wrapWithDeferredLogHandler(Logger, Level) - Static method in class org.springframework.shell.support.logging.HandlerUtils
Replaces each Handler defined against the presented Logger with DeferredLogHandler.
write(int) - Method in class org.springframework.shell.support.logging.LoggingOutputStream
 
write(int) - Method in class org.springframework.shell.support.util.Base64.OutputStream
Writes the byte to the output stream after converting to/from Base64 notation.
write(byte[], int, int) - Method in class org.springframework.shell.support.util.Base64.OutputStream
Calls Base64.OutputStream.write(int) repeatedly until len bytes are written.
writeFormattedXml(OutputStream, Document) - Static method in class org.springframework.shell.support.util.XmlUtils
Write an XML document to the OutputStream provided.
writeXml(OutputStream, Document) - Static method in class org.springframework.shell.support.util.XmlUtils
Write an XML document to the OutputStream provided.
writeXml(Transformer, OutputStream, Document) - Static method in class org.springframework.shell.support.util.XmlUtils
Write an XML document to the OutputStream provided.

X

XmlElementBuilder - Class in org.springframework.shell.support.util
Very simple convenience Builder for XML Elements
XmlElementBuilder(String, Document) - Constructor for class org.springframework.shell.support.util.XmlElementBuilder
Create a new Element instance.
XmlRoundTripUtils - Class in org.springframework.shell.support.util
Utilities related to round-tripping XML documents
XmlUtils - Class in org.springframework.shell.support.util
Utilities related to XML usage.

A B C D E F G H I J L M N O P Q R S T U V W X