uk.autores.handling.package-info Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of annotations Show documentation
Show all versions of annotations Show documentation
Annotation driven library for handling embedded resources
// Copyright 2023 https://github.com/autores-uk/autores/blob/main/LICENSE.txt
// SPDX-License-Identifier: Apache-2.0
/**
* Use these types to extend the API.
*
* Usage
*
*
* -
* Place resource files in the appropriate place for the chosen build system.
*
-
* In Apache Maven this is typically under
*
*
src/main/resources
*
*
*
* -
* Annotate a type or package declaration with {@link uk.autores.handling.ResourceFiles}.
*
* -
* Set the resource file name in the {@link uk.autores.handling.ResourceFiles#value()} array.
*
* -
* Specify a {@link uk.autores.handling.Handler} for non-default behaviour.
*
*
*
* Resource Handlers
*
*
* provided handlers
*
*
* {@link uk.autores.handling.Handler}
* Resources
* Configuration
* Description
*
*
*
*
* {@link uk.autores.handling.AssertResourceExists}
* any files
* (none)
* Default {@link uk.autores.handling.Handler} that validates resources exist.
*
*
* {@link uk.autores.handling.GenerateByteArraysFromFiles}
* any files
* {@link uk.autores.handling.CfgVisibility} {@link uk.autores.handling.CfgStrategy}
* Generates classes with a method that return a resource as a byte array.
*
*
* {@link uk.autores.handling.GenerateConstantsFromProperties}
* {@link java.util.Properties} files
* {@link uk.autores.handling.CfgVisibility}
* Generates classes containing String constants of the keys in a properties file.
*
*
* {@link uk.autores.handling.GenerateInputStreamsFromFiles}
* any files
* {@link uk.autores.handling.CfgVisibility} {@link uk.autores.handling.CfgName}
* Generates a single class with methods for opening resource {@link java.io.InputStream}s.
*
*
* {@link uk.autores.handling.GenerateMessagesFromProperties}
* {@link java.util.Properties} files
* {@link uk.autores.handling.CfgVisibility} {@link uk.autores.handling.CfgLocalize} {@link uk.autores.handling.CfgMissingKey} {@link uk.autores.handling.CfgFormat}
* Generates classes with methods for returning property values including support for localization and message formatting.
*
*
* {@link uk.autores.handling.GenerateStringsFromText}
* text files
* {@link uk.autores.handling.CfgVisibility} {@link uk.autores.handling.CfgEncoding} {@link uk.autores.handling.CfgStrategy}
* Generates classes with a method that return a resource as a string.
*
*
*
*/
package uk.autores.handling;