Top Description Inners Fields Constructors Methods
org.springframework.aot.hint

public final Class JdkProxyHint

extends Object
implements ConditionalHint
Class Inheritance
All Implemented Interfaces
org.springframework.aot.hint.ConditionalHint
Imports
java.lang.reflect.Proxy, java.util.Arrays, .LinkedList, .List, .Objects, org.springframework.lang.Nullable

A hint that describes the need for a JDK interface-based Proxy.
Authors
Stephane Nicoll, Brian Clozel
Since
6.0

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
private final List<TypeReference>
private final TypeReference

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
o
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public List<TypeReference>

Returns:

the interfaces that the proxy should implement
getProxiedInterfaces
()

Return the interfaces to be proxied.

public TypeReference
getReachableType()

Implements org.springframework.aot.hint.ConditionalHint.getReachableType.

Return the type that should be reachable for this hint to apply, or null if this hint should always been applied.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public static JdkProxyHint.Builder

Returns:

a builder for the hint
of
(TypeReference...
the interfaces the proxy should implement
proxiedInterfaces
)

Initialize a builder with the proxied interfaces to use.

public static JdkProxyHint.Builder

Returns:

a builder for the hint
of
(Class<?>...
the interfaces the proxy should implement
proxiedInterfaces
)

Initialize a builder with the proxied interfaces to use.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

proxiedInterfacesback to summary
private final List<TypeReference> proxiedInterfaces
reachableTypeback to summary
private final TypeReference reachableType
Annotations
@Nullable

Constructor Detail

JdkProxyHintback to summary
private JdkProxyHint(JdkProxyHint.Builder builder)

Method Detail

equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getProxiedInterfacesback to summary
public List<TypeReference> getProxiedInterfaces()

Return the interfaces to be proxied.

Returns:List<TypeReference>

the interfaces that the proxy should implement

getReachableTypeback to summary
public TypeReference getReachableType()

Implements org.springframework.aot.hint.ConditionalHint.getReachableType.

Doc from org.springframework.aot.hint.ConditionalHint.getReachableType.

Return the type that should be reachable for this hint to apply, or null if this hint should always been applied.

Returns:TypeReference

the reachable type, if any

Annotations
@Nullable
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
ofback to summary
public static JdkProxyHint.Builder of(TypeReference... proxiedInterfaces)

Initialize a builder with the proxied interfaces to use.

Parameters
proxiedInterfaces:TypeReference[]

the interfaces the proxy should implement

Returns:JdkProxyHint.Builder

a builder for the hint

ofback to summary
public static JdkProxyHint.Builder of(Class<?>... proxiedInterfaces)

Initialize a builder with the proxied interfaces to use.

Parameters
proxiedInterfaces:Class<?>[]

the interfaces the proxy should implement

Returns:JdkProxyHint.Builder

a builder for the hint

org.springframework.aot.hint back to summary

public Class JdkProxyHint.Builder

extends Object
Class Inheritance

Builder for JdkProxyHint.

Field Summary

Modifier and TypeField and Description
private final LinkedList<TypeReference>
private TypeReference

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
pack-priv JdkProxyHint

Returns:

a JDK proxy hint
build
()

Create a JdkProxyHint based on the state of this builder.

public JdkProxyHint.Builder

Returns:

this, to facilitate method chaining
onReachableType
(TypeReference
the type that should be reachable for this hint to apply
reachableType
)

Make this hint conditional on the fact that the specified type can be resolved.

public JdkProxyHint.Builder

Returns:

this, to facilitate method chaining
proxiedInterfaces
(TypeReference...
the interfaces the proxy should implement
proxiedInterfaces
)

Add the specified interfaces that the proxy should implement.

public JdkProxyHint.Builder

Returns:

this, to facilitate method chaining
proxiedInterfaces
(Class<?>...
the interfaces the proxy should implement
proxiedInterfaces
)

Add the specified interfaces that the proxy should implement.

private static List<TypeReference>
toTypeReferences(Class<?>... proxiedInterfaces)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

proxiedInterfacesback to summary
private final LinkedList<TypeReference> proxiedInterfaces
reachableTypeback to summary
private TypeReference reachableType
Annotations
@Nullable

Constructor Detail

Builderback to summary
pack-priv Builder()

Method Detail

buildback to summary
pack-priv JdkProxyHint build()

Create a JdkProxyHint based on the state of this builder.

Returns:JdkProxyHint

a JDK proxy hint

onReachableTypeback to summary
public JdkProxyHint.Builder onReachableType(TypeReference reachableType)

Make this hint conditional on the fact that the specified type can be resolved.

Parameters
reachableType:TypeReference

the type that should be reachable for this hint to apply

Returns:JdkProxyHint.Builder

this, to facilitate method chaining

proxiedInterfacesback to summary
public JdkProxyHint.Builder proxiedInterfaces(TypeReference... proxiedInterfaces)

Add the specified interfaces that the proxy should implement.

Parameters
proxiedInterfaces:TypeReference[]

the interfaces the proxy should implement

Returns:JdkProxyHint.Builder

this, to facilitate method chaining

proxiedInterfacesback to summary
public JdkProxyHint.Builder proxiedInterfaces(Class<?>... proxiedInterfaces)

Add the specified interfaces that the proxy should implement.

Parameters
proxiedInterfaces:Class<?>[]

the interfaces the proxy should implement

Returns:JdkProxyHint.Builder

this, to facilitate method chaining

toTypeReferencesback to summary
private static List<TypeReference> toTypeReferences(Class<?>... proxiedInterfaces)