com.github.robtimus.obfuscation.annotation

Interface ObjectFactory

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface ObjectFactory

A factory for creating objects. This can be used to easily create Obfuscators and CharacterRepresentationProviders from annotations.

Since:

2.0

Author:

Rob Spoor

Method Summary

Modifier and Type	Method and Description
default Optional<CharacterRepresentationProvider>	characterRepresentationProvider(AnnotatedElement annotatedElement) Returns a CharacterRepresentationProvider based on the used annotations in this package.
default Optional<CharacterRepresentationProvider>	characterRepresentationProvider(Annotation... annotations) Returns a CharacterRepresentationProvider based on multiple annotations.
default CharacterRepresentationProvider	characterRepresentationProvider(Class<? extends CharacterRepresentationProvider> providerClass) Returns an instance of a specific CharacterRepresentationProvider type.
default Optional<CharacterRepresentationProvider>	characterRepresentationProvider(Collection<? extends Annotation> annotations) Returns a CharacterRepresentationProvider based on multiple annotations.
default Optional<CharacterRepresentationProvider>	characterRepresentationProvider(Function<Class<? extends Annotation>,Annotation> annotationLookup) Returns a CharacterRepresentationProvider based on the used annotations in this package.
default CharacterRepresentationProvider	characterRepresentationProvider(RepresentedBy annotation) Returns a CharacterRepresentationProvider based on a RepresentedBy annotation.
<T> T	instance(Class<T> type) Returns an instance of a specific type.
default Optional<Obfuscator>	obfuscator(AnnotatedElement annotatedElement) Returns an Obfuscator based on the used annotations in this package.
default Optional<Obfuscator>	obfuscator(Annotation... annotations) Returns an Obfuscator based on multiple annotations.
default Optional<Obfuscator>	obfuscator(Collection<? extends Annotation> annotations) Returns an Obfuscator based on multiple annotations.
default Optional<Obfuscator>	obfuscator(Function<Class<? extends Annotation>,Annotation> annotationLookup) Returns an Obfuscator based on the used annotations in this package.
default Obfuscator	obfuscator(ObfuscateAll annotation) Returns an Obfuscator based on an ObfuscateAll annotation.
default Obfuscator	obfuscator(ObfuscateFixedLength annotation) Returns an Obfuscator based on an ObfuscateFixedLength annotation.
default Obfuscator	obfuscator(ObfuscateFixedValue annotation) Returns an Obfuscator based on an ObfuscateFixedValue annotation.
default Obfuscator	obfuscator(ObfuscateNone annotation) Returns an Obfuscator based on an ObfuscateNone annotation.
default Obfuscator	obfuscator(ObfuscatePortion annotation) Returns an Obfuscator based on an ObfuscatePortion annotation.
default Obfuscator	obfuscator(ObfuscateUsing annotation) Returns an Obfuscator based on an ObfuscateUsing annotation.
default ObfuscatorProvider	obfuscatorProvider(Class<? extends ObfuscatorProvider> providerClass) Returns an instance of a specific ObfuscatorProvider type.
default ObfuscatorProvider	obfuscatorProvider(ObfuscateUsing annotation) Returns an ObfuscatorProvider based on an ObfuscateUsing annotation.
static ObjectFactory	usingReflection() Returns an object factory that uses reflection to create instances.

Method Detail

instance

<T> T instance(Class<T> type)

Returns an instance of a specific type.

Type Parameters:

T - The type to return an instance of.

Parameters:

type - A class representing the type to return an instance of.

Returns:

An instance of the given type.

Throws:

NullPointerException - If the given type is null.

RuntimeException - If no instance could be returned. This is often an exception like IllegalStateException or IllegalArgumentException, but other exceptions are also possible.

obfuscator

default Obfuscator obfuscator(ObfuscateAll annotation)

Returns an Obfuscator based on an ObfuscateAll annotation.

Parameters:

annotation - The annotation to base the returned Obfuscator on.

Returns:

An Obfuscator based on the given annotation.

Throws:

NullPointerException - If the given annotation is null.

obfuscator

default Obfuscator obfuscator(ObfuscateNone annotation)

Returns an Obfuscator based on an ObfuscateNone annotation.

Parameters:

annotation - The annotation to base the returned Obfuscator on.

Returns:

An Obfuscator based on the given annotation.

Throws:

NullPointerException - If the given annotation is null.

obfuscator

default Obfuscator obfuscator(ObfuscateFixedLength annotation)

Returns an Obfuscator based on an ObfuscateFixedLength annotation.

Parameters:

annotation - The annotation to base the returned Obfuscator on.

Returns:

An Obfuscator based on the given annotation.

Throws:

NullPointerException - If the given annotation is null.

obfuscator

default Obfuscator obfuscator(ObfuscateFixedValue annotation)

Returns an Obfuscator based on an ObfuscateFixedValue annotation.

Parameters:

annotation - The annotation to base the returned Obfuscator on.

Returns:

An Obfuscator based on the given annotation.

Throws:

NullPointerException - If the given annotation is null.

obfuscator

default Obfuscator obfuscator(ObfuscatePortion annotation)

Returns an Obfuscator based on an ObfuscatePortion annotation.

Parameters:

annotation - The annotation to base the returned Obfuscator on.

Returns:

An Obfuscator based on the given annotation.

Throws:

NullPointerException - If the given annotation is null.

obfuscator

default Obfuscator obfuscator(ObfuscateUsing annotation)

Returns an Obfuscator based on an ObfuscateUsing annotation.

Parameters:

annotation - The annotation to base the returned Obfuscator on.

Returns:

An Obfuscator based on the given annotation.

Throws:

NullPointerException - If the given annotation is null.

IllegalStateException - If the annotation's provider type cannot be instantiated.

obfuscator

default Optional<Obfuscator> obfuscator(AnnotatedElement annotatedElement)

Returns an Obfuscator based on the used annotations in this package.

Parameters:

annotatedElement - The annotated object for which to check the annotations.

Returns:

An Optional describing the single found Obfuscator based on the used annotations, or Optional.empty() if none of the object's annotations describes an Obfuscator.

Throws:

IllegalStateException - If more than one annotation that describes an Obfuscator is used, or if ObfuscateUsing is used but its provider type cannot be instantiated.

See Also:

ObfuscateAll, ObfuscateNone, ObfuscateFixedLength, ObfuscateFixedValue, ObfuscatePortion, ObfuscateUsing

obfuscator

default Optional<Obfuscator> obfuscator(Function<Class<? extends Annotation>,Annotation> annotationLookup)

Returns an Obfuscator based on the used annotations in this package. This method provides a generic way of checking annotations, in case a lookup other than reflection is used.

Parameters:

annotationLookup - The function that maps an annotation type to the used annotation of that type, or null if the annotation is not used.

Returns:

An Optional describing the single found Obfuscator based on the used annotations, or Optional.empty() if the function does not return any non-null value for any of the annotations in this package.

Throws:

IllegalStateException - If more than one annotation that describes an Obfuscator is used, or if ObfuscateUsing is used but its provider type cannot be instantiated.

See Also:

ObfuscateAll, ObfuscateNone, ObfuscateFixedLength, ObfuscateFixedValue, ObfuscatePortion, ObfuscateUsing

obfuscator

default Optional<Obfuscator> obfuscator(Annotation... annotations)

Returns an Obfuscator based on multiple annotations.

Parameters:

annotations - The annotations to base the returned Obfuscator on.

Returns:

An Optional describing the single found Obfuscator based on the given annotations, or Optional.empty() if none of the annotations describes an Obfuscator.

Throws:

NullPointerException - If any of the annotations is null.

IllegalStateException - If the given annotations contain more than one annotation that describes an Obfuscator, or if the given annotations contain an ObfuscateUsing annotation but its provider type cannot be instantiated.

See Also:

ObfuscateAll, ObfuscateNone, ObfuscateFixedLength, ObfuscateFixedValue, ObfuscatePortion, ObfuscateUsing

obfuscator

default Optional<Obfuscator> obfuscator(Collection<? extends Annotation> annotations)

Returns an Obfuscator based on multiple annotations.

Parameters:

annotations - The annotations to base the returned Obfuscator on.

Returns:

An Optional describing the single found Obfuscator based on the given annotations, or Optional.empty() if none of the annotations describes an Obfuscator.

Throws:

NullPointerException - If any of the annotations is null.

IllegalStateException - If the given annotations contain more than one annotation that describes an Obfuscator, or if the given annotations contain an ObfuscateUsing annotation but its provider type cannot be instantiated.

See Also:

ObfuscateAll, ObfuscateNone, ObfuscateFixedLength, ObfuscateFixedValue, ObfuscatePortion, ObfuscateUsing

obfuscatorProvider

default ObfuscatorProvider obfuscatorProvider(ObfuscateUsing annotation)

Returns an ObfuscatorProvider based on an ObfuscateUsing annotation.

Parameters:

annotation - The annotation to base the returned ObfuscatorProvider on.

Returns:

An ObfuscatorProvider based on the given annotation.

Throws:

NullPointerException - If the given annotation is null.

IllegalStateException - If the annotation's provider type cannot be instantiated.

obfuscatorProvider

default ObfuscatorProvider obfuscatorProvider(Class<? extends ObfuscatorProvider> providerClass)

Returns an instance of a specific ObfuscatorProvider type.

Parameters:

providerClass - The class representing the ObfuscatorProvider type.

Returns:

An instance of the given ObfuscatorProvider type.

Throws:

NullPointerException - If the given class is null.

RuntimeException - If no instance could be returned.

See Also:

instance(Class)

characterRepresentationProvider

default Optional<CharacterRepresentationProvider> characterRepresentationProvider(AnnotatedElement annotatedElement)

Returns a CharacterRepresentationProvider based on the used annotations in this package.

Parameters:

annotatedElement - The annotated object for which to check the annotations.

Returns:

An Optional describing the CharacterRepresentationProvider based on the used annotations, or Optional.empty() if the element is not annotated with RepresentedBy.

Throws:

IllegalStateException - If the element is annotated with RepresentedBy, but its provider type cannot be instantiated.

characterRepresentationProvider

default Optional<CharacterRepresentationProvider> characterRepresentationProvider(Function<Class<? extends Annotation>,Annotation> annotationLookup)

Returns a CharacterRepresentationProvider based on the used annotations in this package. This method provides a generic way of checking annotations, in case a lookup other than reflection is used.

Parameters:

annotationLookup - The function that maps an annotation type to the used annotation of that type, or null if the annotation is not used.

Returns:

An Optional describing the CharacterRepresentationProvider based on the used annotations, or Optional.empty() if the function does not return any non-null value for RepresentedBy.

Throws:

IllegalStateException - If RepresentedBy is used but its provider type cannot be instantiated.

characterRepresentationProvider

default Optional<CharacterRepresentationProvider> characterRepresentationProvider(Annotation... annotations)

Returns a CharacterRepresentationProvider based on multiple annotations.

Parameters:

annotations - The annotations to base the returned CharacterRepresentationProvider on.

Returns:

An Optional describing the single found CharacterRepresentationProvider based on the given annotations, or Optional.empty() if none of the annotations is a RepresentedBy annotation.

Throws:

NullPointerException - If any of the annotations is null.

IllegalStateException - If the given annotations contain more than one RepresentedBy annotation, or if the given annotations contain a RepresentedBy annotation but its provider type cannot be instantiated.

characterRepresentationProvider

default Optional<CharacterRepresentationProvider> characterRepresentationProvider(Collection<? extends Annotation> annotations)

Returns a CharacterRepresentationProvider based on multiple annotations.

Parameters:

annotations - The annotations to base the returned CharacterRepresentationProvider on.

Returns:

An Optional describing the single found CharacterRepresentationProvider based on the given annotations, or Optional.empty() if none of the annotations is a RepresentedBy annotation.

Throws:

NullPointerException - If any of the annotations is null.

IllegalStateException - If the given annotations contain more than one RepresentedBy annotation, or if the given annotations contain a RepresentedBy annotation but its provider type cannot be instantiated.

characterRepresentationProvider

default CharacterRepresentationProvider characterRepresentationProvider(RepresentedBy annotation)

Returns a CharacterRepresentationProvider based on a RepresentedBy annotation.

Parameters:

annotation - The annotation to base the returned CharacterRepresentationProvider on.

Returns:

A CharacterRepresentationProvider based on the given annotation.

Throws:

NullPointerException - If the given annotation is null.

IllegalStateException - If the annotation's provider type cannot be instantiated.

See Also:

characterRepresentationProvider(Class)

characterRepresentationProvider

default CharacterRepresentationProvider characterRepresentationProvider(Class<? extends CharacterRepresentationProvider> providerClass)

Returns an instance of a specific CharacterRepresentationProvider type.

Parameters:

providerClass - The class representing the CharacterRepresentationProvider type.

Returns:

An instance of the given CharacterRepresentationProvider type.

Throws:

NullPointerException - If the given class is null.

RuntimeException - If no instance could be returned.

See Also:

instance(Class)

usingReflection

static ObjectFactory usingReflection()

Returns an object factory that uses reflection to create instances. This requires that each type to be instantiated has a public, no-argument constructor. If this is not the case, then attempting to instantiate a type will result in an IllegalStateException.

Returns:

An object factory that uses reflection to create instances.