Index (AutoRes.uk Annotations 11.0.34-beta API)

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

A

annotated() - Method in class uk.autores.handling.Context: The annotated element.
AssertResourceExists - Class in uk.autores.handling: A resource handler that does nothing but can be used to ensure a resource exists at compile time.
AssertResourceExists() - Constructor for class uk.autores.handling.AssertResourceExists: Public constructor as per contract
AUTO - Enum constant in enum uk.autores.Strategy: Processor is expected to use compile-time heuristics to choose strategy.
AUTO - Static variable in class uk.autores.handling.CfgStrategy: Value
AUTORES - Search tag in package uk.autores: Section
AutoRes.uk - Search tag in module uk.autores: Section

B

build() - Method in class uk.autores.handling.Context.Builder: Creates immutable context instance.
builder() - Static method in class uk.autores.handling.Context: Builder pattern.
ByteArrays - Annotation Type in uk.autores: Annotation for GenerateByteArraysFromFiles.

C

CfgEncoding - Class in uk.autores.handling: "encoding": encoding of consumed text files.
CfgFormat - Class in uk.autores.handling: "format": whether to generate format methods.
CfgIncompatibleFormat - Class in uk.autores.handling: "incompatible-format": how to report incompatible format strings in localized Properties resources.
CfgLocalize - Class in uk.autores.handling: "localize": whether to search for localized resources.
CfgMissingKey - Class in uk.autores.handling: "missing-key": how to report missing keys in localized Properties resources.
CfgName - Class in uk.autores.handling: "name": generated class name.
CfgStrategy - Class in uk.autores.handling: "strategy": how to consume resources.
CfgVisibility - Class in uk.autores.handling: "visibility": set to "public" to generate public instead of package visible artefacts.
charAt(int) - Method in class uk.autores.handling.Pkg
charAt(int) - Method in class uk.autores.handling.Resource
config() - Method in class uk.autores.handling.Context: Configuration.
config() - Method in class uk.autores.handling.GenerateByteArraysFromFiles: All configuration is optional.
config() - Method in class uk.autores.handling.GenerateConstantsFromProperties: All configuration is optional.
config() - Method in class uk.autores.handling.GenerateInputStreamsFromFiles: All configuration is optional.
config() - Method in class uk.autores.handling.GenerateMessagesFromProperties: All configuration is optional.
config() - Method in class uk.autores.handling.GenerateStringsFromText: All configuration is optional.
config() - Method in interface uk.autores.handling.Handler: The configuration supported by this handler.
config() - Element in annotation type uk.autores.handling.ResourceFiles: Some implementations of Handler support configuration.
Config - Class in uk.autores.handling: Config item derived from ResourceFiles.config().
Config(String, String) - Constructor for class uk.autores.handling.Config: Constructor with mandatory values.
ConfigDef - Class in uk.autores.handling: Defines the configuration supported by a Handler.
ConfigDef(String, Predicate<String>) - Constructor for class uk.autores.handling.ConfigDef: Ctor.
CONST - Enum constant in enum uk.autores.Strategy: Generated code embeds data in class constant pool.
CONST - Static variable in class uk.autores.handling.CfgStrategy: Value
Context - Class in uk.autores.handling: Context information for processing resource files.
Context.Builder - Class in uk.autores.handling: Implementation of the builder pattern for Context.

D

DEF - Static variable in class uk.autores.handling.CfgEncoding: Config definition.
DEF - Static variable in class uk.autores.handling.CfgFormat: Config definition.
DEF - Static variable in class uk.autores.handling.CfgIncompatibleFormat: Config definition.
DEF - Static variable in class uk.autores.handling.CfgLocalize: Config definition.
DEF - Static variable in class uk.autores.handling.CfgMissingKey: Config definition.
DEF - Static variable in class uk.autores.handling.CfgName: Name configuration definition
DEF - Static variable in class uk.autores.handling.CfgStrategy: Config definition.
DEF - Static variable in class uk.autores.handling.CfgVisibility: Config definition.

E

encoding() - Element in annotation type uk.autores.Texts: Resource text encoding.
ENCODING - Static variable in class uk.autores.handling.CfgEncoding: Key
env() - Method in class uk.autores.handling.Context: Annotation processing environment.
ERROR - Enum constant in enum uk.autores.Severity: Processor is expected to fail compilation on error.
ERROR - Static variable in class uk.autores.handling.CfgIncompatibleFormat: Value
ERROR - Static variable in class uk.autores.handling.CfgMissingKey: Value
Example - Search tag in class uk.autores.handling.GenerateMessagesFromProperties: Section

F

FALSE - Static variable in class uk.autores.handling.CfgFormat: Value
FALSE - Static variable in class uk.autores.handling.CfgLocalize: Value
format() - Element in annotation type uk.autores.Messages: Generate format signatures.
FORMAT - Static variable in class uk.autores.handling.CfgFormat: Key

G

GenerateByteArraysFromFiles - Class in uk.autores.handling: Handler that, for each resource, generates a class with a name derived from the resource name using Namer.simplifyResourceName(String) and Namer.nameType(String).
GenerateByteArraysFromFiles() - Constructor for class uk.autores.handling.GenerateByteArraysFromFiles: Ctor.
GenerateConstantsFromProperties - Class in uk.autores.handling: Use this code generation Handler to prevent misspelled keys with ResourceBundle.
GenerateConstantsFromProperties() - Constructor for class uk.autores.handling.GenerateConstantsFromProperties: Ctor
GenerateInputStreamsFromFiles - Class in uk.autores.handling: Handler that, for each resource, generates a static method with a name derived from the resource name using Namer.simplifyResourceName(String) and Namer.nameMember(String).
GenerateInputStreamsFromFiles() - Constructor for class uk.autores.handling.GenerateInputStreamsFromFiles: Ctor
GenerateMessagesFromProperties - Class in uk.autores.handling: Handler that generates message classes from Properties files using Locales to match localized strings and MessageFormat to create typed method signatures.
GenerateMessagesFromProperties() - Constructor for class uk.autores.handling.GenerateMessagesFromProperties: Ctor
GenerateStringsFromText - Class in uk.autores.handling: Handler that generates classes that returns file contents as Strings.
GenerateStringsFromText() - Constructor for class uk.autores.handling.GenerateStringsFromText: Ctor

H

handle(Context) - Method in class uk.autores.handling.AssertResourceExists: Does nothing.
handle(Context) - Method in class uk.autores.handling.GenerateByteArraysFromFiles
handle(Context) - Method in class uk.autores.handling.GenerateConstantsFromProperties
handle(Context) - Method in class uk.autores.handling.GenerateInputStreamsFromFiles
handle(Context) - Method in class uk.autores.handling.GenerateMessagesFromProperties
handle(Context) - Method in class uk.autores.handling.GenerateStringsFromText
handle(Context) - Method in interface uk.autores.handling.Handler: Handles the context resources.
handler() - Element in annotation type uk.autores.handling.ResourceFiles: Enables non-default resource handling.
Handler - Interface in uk.autores.handling: Processes resources from the class path.

I

IdiomaticNamer - Class in uk.autores.naming: Generates names that conform to Java naming conventions.
IdiomaticNamer() - Constructor for class uk.autores.naming.IdiomaticNamer: Public no-args constructor as per contract.
IGNORE - Enum constant in enum uk.autores.Severity: Processor is expected to silently ignore problem.
IGNORE - Static variable in class uk.autores.handling.CfgIncompatibleFormat: Value
IGNORE - Static variable in class uk.autores.handling.CfgMissingKey: Value
INCOMPATIBLE_FORMAT - Static variable in class uk.autores.handling.CfgIncompatibleFormat: Key
incompatibleFormat() - Element in annotation type uk.autores.Messages: How to handle incompatible format string in localized files.
INLINE - Enum constant in enum uk.autores.Strategy: Generated code embeds data in class.
INLINE - Static variable in class uk.autores.handling.CfgStrategy: Value
InputStreams - Annotation Type in uk.autores: Annotation for GenerateInputStreamsFromFiles.
isIdentifier(CharSequence) - Static method in class uk.autores.naming.Namer: Tests for valid identifiers - class, method or field names.
isPackage(CharSequence) - Static method in class uk.autores.naming.Namer: Tests for valid package names.
isPublic() - Element in annotation type uk.autores.ByteArrays: Generated code visibility.
isPublic() - Element in annotation type uk.autores.InputStreams: Generated code visibility.
isPublic() - Element in annotation type uk.autores.Keys: Generated code visibility.
isPublic() - Element in annotation type uk.autores.Messages: Generated code visibility.
isPublic() - Element in annotation type uk.autores.Texts: Generated code visibility.
isUnnamed() - Method in class uk.autores.handling.Pkg: NOTE: use of the unnamed package is highly discouraged.
isValid(String) - Method in class uk.autores.handling.ConfigDef: Tests validity of value.

K

key() - Method in class uk.autores.handling.Config: Key.
key() - Method in class uk.autores.handling.ConfigDef: Configuration key.
key() - Element in annotation type uk.autores.handling.ResourceFiles.Cfg: Key.
Keys - Annotation Type in uk.autores: Annotation for GenerateConstantsFromProperties.

L

lastSegment() - Method in class uk.autores.handling.Pkg: For package "foo.bar" returns "bar".
LAZY - Enum constant in enum uk.autores.Strategy: Generated code loads data at runtime.
LAZY - Static variable in class uk.autores.handling.CfgStrategy: Value
length() - Method in class uk.autores.handling.Pkg
length() - Method in class uk.autores.handling.Resource
Links - Search tag in package uk.autores: Section
localize() - Element in annotation type uk.autores.Messages: Search for localized properties.
LOCALIZE - Static variable in class uk.autores.handling.CfgLocalize: Key
locations() - Method in class uk.autores.handling.Context: Filer locations to search.
locations() - Element in annotation type uk.autores.Processing: These values are passed as location (1st arg) to Filer.getResource(JavaFileManager.Location, CharSequence, CharSequence) in order.

M

Messages - Annotation Type in uk.autores: Annotation for GenerateMessagesFromProperties.
MISSING_KEY - Static variable in class uk.autores.handling.CfgMissingKey: Key
missingKey() - Element in annotation type uk.autores.Messages: How to handle missing keys in localized files.
Modules - Search tag in module uk.autores: Section

N

name() - Element in annotation type uk.autores.InputStreams: Generated class name.
NAME - Static variable in class uk.autores.handling.CfgName: Key
nameConstant(String) - Method in class uk.autores.naming.IdiomaticNamer: For input "foo-bar-baz" returns "FOO_BAR_BAZ".
nameConstant(String) - Method in class uk.autores.naming.Namer: Name a public static final field.
named(CharSequence) - Static method in class uk.autores.handling.Pkg: Instantiates an instance, decorating the given sequence.
nameMember(String) - Method in class uk.autores.naming.IdiomaticNamer: For input "foo-bar-baz" returns "fooBarBaz".
nameMember(String) - Method in class uk.autores.naming.Namer: Name a method/field/etc.
namer() - Method in class uk.autores.handling.Context: Naming strategy.
namer() - Element in annotation type uk.autores.Processing: Set this value to provide alternative class/member naming strategy.
Namer - Class in uk.autores.naming: Base type for naming classes, methods and fields.
Namer() - Constructor for class uk.autores.naming.Namer: Public no-args constructor as per contract.
nameType(String) - Method in class uk.autores.naming.IdiomaticNamer: For input "foo-bar-baz" returns "FooBarBaz".
nameType(String) - Method in class uk.autores.naming.Namer: Name a class/interface/etc.

O

open() - Method in class uk.autores.handling.Resource: Opens resource for reading.
open() - Method in interface uk.autores.handling.Resource.ResourceOpener: Opens resource for reading.
option(ConfigDef) - Method in class uk.autores.handling.Context: First Config.value() where Config.value() equals ConfigDef.key().

P

pkg() - Method in class uk.autores.handling.Context: The package of the annotated type.
pkg(CharSequence, CharSequence) - Static method in class uk.autores.handling.ResourceFiling: Resolves the package string to be passed to Filer.getResource(JavaFileManager.Location, CharSequence, CharSequence).
Pkg - Class in uk.autores.handling: Character representation of a Java package.
printError(String) - Method in class uk.autores.handling.Context: Convenience method for sending an error to the Messager.
processing() - Element in annotation type uk.autores.ByteArrays: Common processing instructions.
processing() - Element in annotation type uk.autores.handling.ResourceFiles: Common processing instructions
processing() - Element in annotation type uk.autores.InputStreams: Common processing instructions.
processing() - Element in annotation type uk.autores.Keys: Common processing instructions.
processing() - Element in annotation type uk.autores.Messages: Common processing instructions.
processing() - Element in annotation type uk.autores.Texts: Common processing instructions.
Processing - Annotation Type in uk.autores: Common processing instructions annotation.
PUBLIC - Static variable in class uk.autores.handling.CfgVisibility: Value

Q

qualifiedClassName(String) - Method in class uk.autores.handling.Pkg: For a package "foo.bar" and a simple name "Baz" returns "foo.bar.Baz".

R

rebuild() - Method in class uk.autores.handling.Context: Context.Builder initialized from current state.
relativeName(CharSequence) - Static method in class uk.autores.handling.ResourceFiling: Resolves the relative name to be passed to Filer.getResource(JavaFileManager.Location, CharSequence, CharSequence).
RepeatableByteArrays - Annotation Type in uk.autores.repeat: Allows ByteArrays to be used multiple times on a package or class.
RepeatableInputStreams - Annotation Type in uk.autores.repeat: Allows InputStreams to be used multiple times on a package or class.
RepeatableKeys - Annotation Type in uk.autores.repeat: Allows Keys to be used multiple times on a package or class.
RepeatableMessages - Annotation Type in uk.autores.repeat: Allows Messages to be used multiple times on a package or class.
RepeatableResources - Annotation Type in uk.autores.repeat: Allows ResourceFiles to be used multiple times on a package or class.
RepeatableTexts - Annotation Type in uk.autores.repeat: Allows Texts to be used multiple times on a package or class.
Resource - Class in uk.autores.handling: A representation of the annotated resource.
Resource(Resource.ResourceOpener, String) - Constructor for class uk.autores.handling.Resource: All arguments must be non-null.
Resource.ResourceOpener - Interface in uk.autores.handling: For retrieving resource contents.
ResourceFiles - Annotation Type in uk.autores.handling: Indicates resources that are to be processed at compile time.
ResourceFiles.Cfg - Annotation Type in uk.autores.handling: Configuration option.
ResourceFiling - Class in uk.autores.handling: Utility type for working with Filer.
Resource Handlers - Search tag in package uk.autores.handling: Section
resources() - Method in class uk.autores.handling.Context: Resources to process.

S

setAnnotated(Element) - Method in class uk.autores.handling.Context.Builder: Sets package or type.
setConfig(List<Config>) - Method in class uk.autores.handling.Context.Builder: Sets configuration.
setEnv(ProcessingEnvironment) - Method in class uk.autores.handling.Context.Builder: Sets processing environment.
setLocation(List<JavaFileManager.Location>) - Method in class uk.autores.handling.Context.Builder: Sets locations to search.
setNamer(Namer) - Method in class uk.autores.handling.Context.Builder: Sets naming conventions.
setPkg(Pkg) - Method in class uk.autores.handling.Context.Builder: Sets annotated package.
setResources(List<Resource>) - Method in class uk.autores.handling.Context.Builder: Sets resources to process.
Severity - Enum in uk.autores: Error handling choices enum.
simplifyResourceName(String) - Method in class uk.autores.naming.Namer: Reduces a resource name to a simpler form.
strategy() - Element in annotation type uk.autores.ByteArrays: Code generation strategy.
strategy() - Element in annotation type uk.autores.Texts: Code generation strategy.
Strategy - Enum in uk.autores: Code generation choices enum.
STRATEGY - Static variable in class uk.autores.handling.CfgStrategy: Key
subSequence(int, int) - Method in class uk.autores.handling.Pkg
subSequence(int, int) - Method in class uk.autores.handling.Resource

T

Texts - Annotation Type in uk.autores: Annotation for GenerateStringsFromText.
toString() - Method in class uk.autores.handling.Config
toString() - Method in class uk.autores.handling.Pkg
toString() - Method in class uk.autores.handling.Resource
TRUE - Static variable in class uk.autores.handling.CfgFormat: Value
TRUE - Static variable in class uk.autores.handling.CfgLocalize: Value

U

uk.autores - module uk.autores: AutoRes.uk
uk.autores - package uk.autores: An annotation driven library for working with embedded resource files.
uk.autores.handling - package uk.autores.handling: Use these types to extend the API.
uk.autores.naming - package uk.autores.naming: Types for naming classes and their members during code generation.
uk.autores.repeat - package uk.autores.repeat: Annotations in this package do not need to be referenced by API consumers - they are used automatically when an annotation is used more than once on package or type.
Usage - Search tag in package uk.autores: Section
Usage - Search tag in package uk.autores.handling: Section

V

validConfig(List<Config>, Consumer<String>) - Method in interface uk.autores.handling.Handler: Validates the Context.config().
value() - Element in annotation type uk.autores.ByteArrays: Resource files.
value() - Method in class uk.autores.handling.Config: Value.
value() - Element in annotation type uk.autores.handling.ResourceFiles.Cfg: Value.
value() - Element in annotation type uk.autores.handling.ResourceFiles: Defines the resource files to be processed.
value() - Element in annotation type uk.autores.InputStreams: Resource files.
value() - Element in annotation type uk.autores.Keys: Resource files.
value() - Element in annotation type uk.autores.Messages: Resource files.
value() - Element in annotation type uk.autores.repeat.RepeatableByteArrays: Repeating elements.
value() - Element in annotation type uk.autores.repeat.RepeatableInputStreams: Repeating elements.
value() - Element in annotation type uk.autores.repeat.RepeatableKeys: Repeating elements.
value() - Element in annotation type uk.autores.repeat.RepeatableMessages: Repeating elements.
value() - Element in annotation type uk.autores.repeat.RepeatableResources: Repeating elements.
value() - Element in annotation type uk.autores.repeat.RepeatableTexts: Repeating elements.
value() - Method in enum uk.autores.Severity: Underlying string value.
value() - Method in enum uk.autores.Strategy: Underlying string value.
value() - Element in annotation type uk.autores.Texts: Resource files.
valueOf(String) - Static method in enum uk.autores.Severity: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum uk.autores.Strategy: Returns the enum constant of this type with the specified name.
values() - Static method in enum uk.autores.Severity: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum uk.autores.Strategy: Returns an array containing the constants of this enum type, in the order they are declared.
VISIBILITY - Static variable in class uk.autores.handling.CfgVisibility: Key

W

WARN - Enum constant in enum uk.autores.Severity: Processor is expected to emit message but continue.
WARN - Static variable in class uk.autores.handling.CfgIncompatibleFormat: Value
WARN - Static variable in class uk.autores.handling.CfgMissingKey: Value

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