uk.co.strangeskies.reflection.codegen

Class ClassSignature<T>

java.lang.Object

uk.co.strangeskies.reflection.codegen.ClassSignature<T>

Type Parameters:

T - the intersection of the supertypes of the described class

All Implemented Interfaces:

AnnotatedSignature<ClassSignature<T>>, ParameterizedSignature<ClassSignature<T>>, Signature<ClassSignature<T>>

public class ClassSignature<T>
extends java.lang.Object
implements ParameterizedSignature<ClassSignature<T>>

Separating the logic for declaring the class into a builder allows us to ensure the type of the class is immutable once an actual ClassDefinition object is instantiated. This means that the type can be safely reasoned about before any class members are defined or any implementation details are specified.

A class signature contains a number of method signatures. Some of these signatures may be implied by inheritance, and some may be explicitly attached. When a class signature is declared, each of those signatures is realized into a corresponding method declaration.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ClassSignature()
protected	ClassSignature(java.lang.String packageName, java.lang.String simpleName, java.lang.String enclosingClassName, java.lang.reflect.AnnotatedType superClass, java.util.Set<java.lang.reflect.AnnotatedType> superInterfaces, java.util.Set<ConstructorSignature> constructorSignatures, java.util.Set<MethodSignature<?>> methodSignatures, java.util.List<TypeVariableSignature> typeVariables, java.util.Set<java.lang.annotation.Annotation> annotations, Modifiers modifiers)

Method Summary

Modifier and Type	Method and Description
ClassSignature<T>	annotated(java.util.Collection<? extends java.lang.annotation.Annotation> annotations) Derive a version of this declaration with the given annotations.
static ClassSignature<java.lang.Object>	classSignature()
static <T> ClassSignature<T>	classSignature(java.lang.Class<T> clazz) Create the class signature describing the given class.
ClassSignature<T>	constructor(ConstructorSignature constructorSignature)
ClassSignature<T>	enclosingClassName(java.lang.String enclosingClassName)
ClassSignature<?>	extending(java.lang.reflect.AnnotatedType... superType)
<U> ClassSignature<? extends U>	extending(java.lang.Class<U> superType)
ClassSignature<?>	extending(java.util.Collection<? extends java.lang.reflect.AnnotatedType> superType)
ClassSignature<?>	extending(java.lang.reflect.Type... superType)
<U> ClassSignature<? extends U>	extending(TypeToken<? extends U>... superType)
<U> ClassSignature<? extends U>	extending(TypeToken<U> superType)
java.util.stream.Stream<? extends java.lang.annotation.Annotation>	getAnnotations()
protected java.lang.String	getClassName()
java.util.stream.Stream<? extends ConstructorSignature>	getConstructors()
java.util.Optional<java.lang.String>	getEnclosingClassName()
java.util.stream.Stream<? extends MethodSignature<?>>	getMethods()
Modifiers	getModifiers()
protected java.util.Optional<java.lang.String>	getPackageName()
protected java.lang.String	getSimpleName()
protected java.util.Optional<? extends java.lang.reflect.AnnotatedType>	getSuperClass()
protected java.util.stream.Stream<? extends java.lang.reflect.AnnotatedType>	getSuperInterfaces()
java.util.stream.Stream<? extends TypeVariableSignature>	getTypeVariables()
ClassSignature<T>	method(MethodSignature<?> methodSignature)
ClassSignature<T>	packageName(java.util.function.Function<java.lang.String,java.lang.String> packageNameTransformation)
ClassSignature<T>	packageName(java.lang.String packageName)
ClassSignature<T>	simpleName(java.util.function.Function<java.lang.String,java.lang.String> simpleNameTransformation)
ClassSignature<T>	simpleName(java.lang.String simpleName)
ClassSignature<T>	typeVariables(java.util.Collection<? extends TypeVariableSignature> typeVariables)
protected ClassSignature<T>	withModifiers(Modifiers modifiers)
ClassSignature<T>	withVisibility(Visibility visibility)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface uk.co.strangeskies.reflection.codegen.ParameterizedSignature

appendTypeParametersTo, typeVariables, typeVariables

Methods inherited from interface uk.co.strangeskies.reflection.codegen.AnnotatedSignature

annotated

Methods inherited from interface uk.co.strangeskies.reflection.codegen.Signature

toString

Constructor Detail

ClassSignature

protected ClassSignature()

ClassSignature

protected ClassSignature(java.lang.String packageName,
                         java.lang.String simpleName,
                         java.lang.String enclosingClassName,
                         java.lang.reflect.AnnotatedType superClass,
                         java.util.Set<java.lang.reflect.AnnotatedType> superInterfaces,
                         java.util.Set<ConstructorSignature> constructorSignatures,
                         java.util.Set<MethodSignature<?>> methodSignatures,
                         java.util.List<TypeVariableSignature> typeVariables,
                         java.util.Set<java.lang.annotation.Annotation> annotations,
                         Modifiers modifiers)

Method Detail

classSignature

public static ClassSignature<java.lang.Object> classSignature()

classSignature

public static <T> ClassSignature<T> classSignature(java.lang.Class<T> clazz)

Create the class signature describing the given class.

Parameters:

clazz - the class whose signature we wish to create

Returns:

a signature describing the given class

getClassName

protected java.lang.String getClassName()

getPackageName

protected java.util.Optional<java.lang.String> getPackageName()

packageName

public ClassSignature<T> packageName(java.lang.String packageName)

packageName

public ClassSignature<T> packageName(java.util.function.Function<java.lang.String,java.lang.String> packageNameTransformation)

getSimpleName

protected java.lang.String getSimpleName()

simpleName

public ClassSignature<T> simpleName(java.lang.String simpleName)

simpleName

public ClassSignature<T> simpleName(java.util.function.Function<java.lang.String,java.lang.String> simpleNameTransformation)

getModifiers

public Modifiers getModifiers()

withModifiers

protected ClassSignature<T> withModifiers(Modifiers modifiers)

withVisibility

public ClassSignature<T> withVisibility(Visibility visibility)

getEnclosingClassName

public java.util.Optional<java.lang.String> getEnclosingClassName()

enclosingClassName

public ClassSignature<T> enclosingClassName(java.lang.String enclosingClassName)

getSuperClass

protected java.util.Optional<? extends java.lang.reflect.AnnotatedType> getSuperClass()

getSuperInterfaces

protected java.util.stream.Stream<? extends java.lang.reflect.AnnotatedType> getSuperInterfaces()

extending

public ClassSignature<?> extending(java.lang.reflect.Type... superType)

Parameters:

superType - the supertype for the class signature

Returns:

the receiver

extending

public ClassSignature<?> extending(java.lang.reflect.AnnotatedType... superType)

Parameters:

superType - the supertype for the class signature

Returns:

the receiver

extending

public <U> ClassSignature<? extends U> extending(java.lang.Class<U> superType)

Type Parameters:

U - the supertype for the class signature

Parameters:

superType - the supertype for the class signature

Returns:

the receiver

extending

public <U> ClassSignature<? extends U> extending(TypeToken<U> superType)

Type Parameters:

U - the supertype for the class signature

Parameters:

superType - the supertype for the class signature

Returns:

the receiver

extending

@SafeVarargs
public final <U> ClassSignature<? extends U> extending(TypeToken<? extends U>... superType)

Type Parameters:

U - the supertype for the class signature

Parameters:

superType - the supertype for the class signature

Returns:

the receiver

extending

public ClassSignature<?> extending(java.util.Collection<? extends java.lang.reflect.AnnotatedType> superType)

Parameters:

superType - the supertype for the class signature

Returns:

the receiver

getConstructors

public java.util.stream.Stream<? extends ConstructorSignature> getConstructors()

constructor

public ClassSignature<T> constructor(ConstructorSignature constructorSignature)

getMethods

public java.util.stream.Stream<? extends MethodSignature<?>> getMethods()

method

public ClassSignature<T> method(MethodSignature<?> methodSignature)

getAnnotations

public java.util.stream.Stream<? extends java.lang.annotation.Annotation> getAnnotations()

Specified by:

getAnnotations in interface AnnotatedSignature<ClassSignature<T>>

Returns:

the annotations on this declaration

annotated

public ClassSignature<T> annotated(java.util.Collection<? extends java.lang.annotation.Annotation> annotations)

Description copied from interface: AnnotatedSignature

Derive a version of this declaration with the given annotations. Users should take care not to specify annotations which could not be applied to the declaration due to their Target, as there is no validation of applicability.

Annotations already present on the receiving declaration will be replaced rather than appended.

Specified by:

annotated in interface AnnotatedSignature<ClassSignature<T>>

Parameters:

annotations - the annotations with which to annotate this declaration

Returns:

a new declaration of the same type, and with the same content, but with the given annotations

getTypeVariables

public java.util.stream.Stream<? extends TypeVariableSignature> getTypeVariables()

Specified by:

getTypeVariables in interface ParameterizedSignature<ClassSignature<T>>

typeVariables

public ClassSignature<T> typeVariables(java.util.Collection<? extends TypeVariableSignature> typeVariables)

Specified by:

typeVariables in interface ParameterizedSignature<ClassSignature<T>>