Index (PFL Basic Tools 5.1.0 API)

A B C D E F G H I M O P R S T V W
All Classes and Interfaces|All Packages|Constant Field Values

A

ActionFactory - Class in org.glassfish.pfl.basic.tools.file
ActionFactory() - Constructor for class org.glassfish.pfl.basic.tools.file.ActionFactory
ActionFactory(int) - Constructor for class org.glassfish.pfl.basic.tools.file.ActionFactory
ActionFactory(int, boolean) - Constructor for class org.glassfish.pfl.basic.tools.file.ActionFactory
addAfterLast(String) - Method in class org.glassfish.pfl.basic.tools.file.Block: Add String after the end of the block.
addBeforeFirst(String) - Method in class org.glassfish.pfl.basic.tools.file.Block: Add String before the start of the block.
addDirectoryToSkip(String) - Method in class org.glassfish.pfl.basic.tools.file.Scanner: Add a pattern that defines a directory to skip.
addKnownName(String, Scanner.Action) - Method in class org.glassfish.pfl.basic.tools.file.Recognizer
addKnownSuffix(String, Scanner.Action) - Method in class org.glassfish.pfl.basic.tools.file.Recognizer
addPrefixToAll(String) - Method in class org.glassfish.pfl.basic.tools.file.Block: Add the prefix to each string in the block.
addTag(String) - Method in class org.glassfish.pfl.basic.tools.file.Block: Add a tag to the block.
ArgParser - Class in org.glassfish.pfl.basic.tools.argparser: A general purpose argument parser that uses annotations, reflection, and generics.
ArgParser(Class<?>) - Constructor for class org.glassfish.pfl.basic.tools.argparser.ArgParser: Construct an ArgParser that parses an argument string into an instance of the Class argument.
ArgParser(List<Class<?>>) - Constructor for class org.glassfish.pfl.basic.tools.argparser.ArgParser
ArgParser.StringPair - Class in org.glassfish.pfl.basic.tools.argparser: Useful utility class for parsing pairs of strings.

B

Block - Class in org.glassfish.pfl.basic.tools.file: Represents a range of Strings, typically read from a file, that are in some sense related and contiguous.
Block(List<String>) - Constructor for class org.glassfish.pfl.basic.tools.file.Block: Create a new Block from a list of strings.
Block(Block) - Constructor for class org.glassfish.pfl.basic.tools.file.Block: Create a new Block which is a copy of block.
BlockParser - Class in org.glassfish.pfl.basic.tools.file: Utility class used to convert FileWrappers into (lists of) Blocks.

C

canWrite() - Method in class org.glassfish.pfl.basic.tools.file.FileWrapper
close() - Method in class org.glassfish.pfl.basic.tools.file.FileWrapper: Close the file, and set its state to CLOSED.
CLOSED - Enum constant in enum org.glassfish.pfl.basic.tools.file.FileWrapper.FileState
COMMENT_BLOCK_TAG - Static variable in class org.glassfish.pfl.basic.tools.file.BlockParser
contents() - Method in class org.glassfish.pfl.basic.tools.file.Block: Get the contents of the block.
copyTo(FileWrapper, byte[]) - Method in class org.glassfish.pfl.basic.tools.file.FileWrapper: Copy this file to target using buffer to hold data.

D

DefaultValue - Annotation Type in org.glassfish.pfl.basic.tools.argparser
delete() - Method in class org.glassfish.pfl.basic.tools.file.FileWrapper
describe() - Method in interface org.glassfish.pfl.basic.tools.argparser.ElementParser
describe() - Method in class org.glassfish.pfl.basic.tools.argparser.ElementParserImpl
dump() - Method in class org.glassfish.pfl.basic.tools.file.Recognizer

E

ElementParser - Interface in org.glassfish.pfl.basic.tools.argparser
ElementParserImpl - Class in org.glassfish.pfl.basic.tools.argparser
ElementParserImpl(Method) - Constructor for class org.glassfish.pfl.basic.tools.argparser.ElementParserImpl
equals(Object) - Method in class org.glassfish.pfl.basic.tools.file.Block
evaluate(String) - Method in class org.glassfish.pfl.basic.tools.argparser.ElementParserImpl
evaluate(FileWrapper) - Method in class org.glassfish.pfl.basic.tools.file.Recognizer: Apply the action that matches the classification of this file.
ExceptionResourceGenerator - Class in org.glassfish.pfl.basic.tools.logex: Scans a directory looking for class files.
expandTabs() - Method in class org.glassfish.pfl.basic.tools.file.Block: Replace tabs with spaces, assuming tab stops are located as usual at n*8 + 1

F

factory - Static variable in interface org.glassfish.pfl.basic.tools.argparser.ElementParser
FileWrapper - Class in org.glassfish.pfl.basic.tools.file: File wrapper for text files.
FileWrapper(File) - Constructor for class org.glassfish.pfl.basic.tools.file.FileWrapper: Create a new FileWrapper for the given File.
FileWrapper(File, String) - Constructor for class org.glassfish.pfl.basic.tools.file.FileWrapper
FileWrapper(String) - Constructor for class org.glassfish.pfl.basic.tools.file.FileWrapper
FileWrapper.FileState - Enum in org.glassfish.pfl.basic.tools.file
FileWrapper.OpenMode - Enum in org.glassfish.pfl.basic.tools.file
find(String) - Method in class org.glassfish.pfl.basic.tools.file.Block: Return the first string in the block that contains the search string.

G

getAbsoluteName() - Method in class org.glassfish.pfl.basic.tools.file.FileWrapper
getBlock(FileWrapper) - Static method in class org.glassfish.pfl.basic.tools.file.BlockParser: Return the contents of the text file as a Block.
getFileState() - Method in class org.glassfish.pfl.basic.tools.file.FileWrapper
getHelpText() - Method in class org.glassfish.pfl.basic.tools.argparser.ArgParser: Returns a formatted text string that describes the expected arguments for this parser.
getName() - Method in class org.glassfish.pfl.basic.tools.file.FileWrapper
getRecognizerAction() - Method in class org.glassfish.pfl.basic.tools.file.ActionFactory
getResources(Class<?>) - Static method in class org.glassfish.pfl.basic.tools.logex.ExceptionResourceGenerator: Generate a list of Strings for a resource file for the given exception and log handling class.
getSkipAction() - Method in class org.glassfish.pfl.basic.tools.file.ActionFactory: returns an action that returns true.
getStopAction() - Method in class org.glassfish.pfl.basic.tools.file.ActionFactory: returns an action that returns false.

H

hashCode() - Method in class org.glassfish.pfl.basic.tools.file.Block
hasTag(String) - Method in class org.glassfish.pfl.basic.tools.file.Block: Return whether or not a block has a particular tag.
hasTags(String...) - Method in class org.glassfish.pfl.basic.tools.file.Block: Return whether or not a block has ALL of the listed tags.
Help - Annotation Type in org.glassfish.pfl.basic.tools.argparser

I

instantiateTemplate(Map<String, String>) - Method in class org.glassfish.pfl.basic.tools.file.Block: replace all occurrences of @KEY@ with parameters.get( KEY ).

M

main(String[]) - Static method in class org.glassfish.pfl.basic.tools.argparser.ArgParser
main(String[]) - Static method in class org.glassfish.pfl.basic.tools.file.WorkspaceRename
main(String[]) - Static method in class org.glassfish.pfl.basic.tools.logex.ExceptionResourceGenerator

O

open(FileWrapper.OpenMode) - Method in class org.glassfish.pfl.basic.tools.file.FileWrapper: Open the (text) file for I/O.
OPEN_FOR_READ - Enum constant in enum org.glassfish.pfl.basic.tools.file.FileWrapper.FileState
OPEN_FOR_WRITE - Enum constant in enum org.glassfish.pfl.basic.tools.file.FileWrapper.FileState
org.glassfish.pfl.basic.tools - module org.glassfish.pfl.basic.tools
org.glassfish.pfl.basic.tools.argparser - package org.glassfish.pfl.basic.tools.argparser
org.glassfish.pfl.basic.tools.file - package org.glassfish.pfl.basic.tools.file
org.glassfish.pfl.basic.tools.logex - package org.glassfish.pfl.basic.tools.logex

P

parse(String[]) - Method in class org.glassfish.pfl.basic.tools.argparser.ArgParser: Parse the argument string into an instance of type T.
parse(String[], Class<T>) - Method in class org.glassfish.pfl.basic.tools.argparser.ArgParser
parseBlocks(FileWrapper, String) - Static method in class org.glassfish.pfl.basic.tools.file.BlockParser: Transform fw into a list of blocks.
parseBlocks(FileWrapper, String, String) - Static method in class org.glassfish.pfl.basic.tools.file.BlockParser: Transform fw into a list of blocks.
parseInt() - Method in class org.glassfish.pfl.basic.tools.file.StringParser: Return int matched at current position as a string.

R

READ - Enum constant in enum org.glassfish.pfl.basic.tools.file.FileWrapper.OpenMode
readAll() - Method in class org.glassfish.pfl.basic.tools.file.FileWrapper
readLine() - Method in class org.glassfish.pfl.basic.tools.file.FileWrapper: Read the next line from the text file.
Recognizer - Class in org.glassfish.pfl.basic.tools.file: Recognizes files according to patterns, and performs actions accordingly.

S

scan(Scanner.Action) - Method in class org.glassfish.pfl.basic.tools.file.Scanner: Scan all files reachable from roots.
Scanner - Class in org.glassfish.pfl.basic.tools.file: Recursively scan directories to process files.
Scanner(int, File...) - Constructor for class org.glassfish.pfl.basic.tools.file.Scanner
Scanner(int, List<File>) - Constructor for class org.glassfish.pfl.basic.tools.file.Scanner
Scanner.Action - Interface in org.glassfish.pfl.basic.tools.file: Action interface passed to scan method to act on files.
Separator - Annotation Type in org.glassfish.pfl.basic.tools.argparser
setDefaultAction(Scanner.Action) - Method in class org.glassfish.pfl.basic.tools.file.Recognizer: This defines the default action.
setShellScriptAction(Scanner.Action) - Method in class org.glassfish.pfl.basic.tools.file.Recognizer: If set, this defines the action taken for text files that start with the patter "#!"
skipString(String) - Method in class org.glassfish.pfl.basic.tools.file.StringParser: skip over str, if str is at the current position.
skipToString(String) - Method in class org.glassfish.pfl.basic.tools.file.StringParser: skip everything until str is found.
skipWhitespace() - Method in class org.glassfish.pfl.basic.tools.file.StringParser: Skip over whitespace.
splitFirst() - Method in class org.glassfish.pfl.basic.tools.file.Block: Split block into two blocks, with only the first line of the original Block in result.first().
StringPair(String) - Constructor for class org.glassfish.pfl.basic.tools.argparser.ArgParser.StringPair: Construct a StringPair from data of the first first:second.
StringPair(String, String) - Constructor for class org.glassfish.pfl.basic.tools.argparser.ArgParser.StringPair
StringParser - Class in org.glassfish.pfl.basic.tools.file
StringParser(String) - Constructor for class org.glassfish.pfl.basic.tools.file.StringParser
substitute(List<? extends Pair<String, String>>) - Method in class org.glassfish.pfl.basic.tools.file.Block

T

toString() - Method in class org.glassfish.pfl.basic.tools.file.Block
toString() - Method in class org.glassfish.pfl.basic.tools.file.FileWrapper
toString() - Method in class org.glassfish.pfl.basic.tools.file.Recognizer

V

value() - Element in annotation type org.glassfish.pfl.basic.tools.argparser.DefaultValue
value() - Element in annotation type org.glassfish.pfl.basic.tools.argparser.Help
value() - Element in annotation type org.glassfish.pfl.basic.tools.argparser.Separator
valueOf(String) - Static method in enum org.glassfish.pfl.basic.tools.file.FileWrapper.FileState: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.glassfish.pfl.basic.tools.file.FileWrapper.OpenMode: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.glassfish.pfl.basic.tools.file.FileWrapper.FileState: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.glassfish.pfl.basic.tools.file.FileWrapper.OpenMode: Returns an array containing the constants of this enum type, in the order they are declared.

W

WorkspaceRename - Class in org.glassfish.pfl.basic.tools.file
WorkspaceRename(String[]) - Constructor for class org.glassfish.pfl.basic.tools.file.WorkspaceRename
write(FileWrapper) - Method in class org.glassfish.pfl.basic.tools.file.Block: Write block to FileWrapper.
WRITE - Enum constant in enum org.glassfish.pfl.basic.tools.file.FileWrapper.OpenMode
WRITE_EMPTY - Enum constant in enum org.glassfish.pfl.basic.tools.file.FileWrapper.OpenMode
writeAll(byte[]) - Method in class org.glassfish.pfl.basic.tools.file.FileWrapper
writeLine(String) - Method in class org.glassfish.pfl.basic.tools.file.FileWrapper: Write the line to the end of the file, including a newline.

A B C D E F G H I M O P R S T V W
All Classes and Interfaces|All Packages|Constant Field Values