uk.autores.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
/**
*
* An annotation driven library for working with embedded resource files.
* This package contains the core library functionality.
* See other packages for annotation processing and extensibility.
*
* AUTORES
*
* Usage
*
*
* -
* Add {@code import uk.autores.*;}
*
* -
* Annotate a package ({@link java.lang.annotation.ElementType#PACKAGE})
* or type ({@link java.lang.annotation.ElementType#TYPE}) with one
* of the provided annotations
*
* -
* Set {@code String[] values()} to the resource file names
*
*
*
*
* Annotation Summary
*
* Annotation
* Consumes
* Description
*
*
* {@link uk.autores.ByteArrays}
* any file
* Generate one class per file that returns byte[].
*
*
* {@link uk.autores.InputStreams}
* any file
* Generate single class with one {@link java.io.InputStream} method per file.
*
*
* {@link uk.autores.Keys}
* properties
* Generate one constants class with keys per {@link java.util.Properties} file.
*
*
* {@link uk.autores.Messages}
* properties
* Generate one localized, formatting message generator class per {@link java.util.Properties} file.
*
*
* {@link uk.autores.Texts}
* text files
* Generate one class per text file that returns {@link java.lang.String}.
*
*
*
* Links
*
*
* - Source code
* - Website
*
*/
package uk.autores;