ftbsc.lll.processor.annotations

Annotation Type Target

@Retention(value=CLASS)
 @Repeatable(value=Target.List.class)
 @Target(value=METHOD)
public @interface Target

Marks a method as the target method. The method annotated with this, called "stub" within the documentation, should have the same name and parameters as the method it's supposed to represent. It will be discarded unless the containing class is annotated with Patch and at least another method within the class is annotated with Injector.

See Also:

Patch, Injector

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	of Indicates which of the methods annotated with Find or Injector is targeting this stub.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	bridge When set to true, tells the processor to try to match the synthetic "bridge" method generated by the compiler to handle type erasure.
boolean	lookForParent Deprecated. This is meant as a temporary workaround and will be removed in an upcoming patch as better logic for parent-lookup in mappings is introduced. When that happens, setting this to false will be rendered moot, so you can just remove this from your annotations.
java.lang.String	methodName Provides a name to be used instead of the stub's.
boolean	strict When set to false, tells the processor to first try to match a single method by name, and to only check parameters if further clarification is needed.

Element Detail

of

public abstract java.lang.String of

Indicates which of the methods annotated with Find or Injector is targeting this stub.

Returns:

the name of the element this is supposed to apply to

Since:

0.5.0

methodName

public abstract java.lang.String methodName

Provides a name to be used instead of the stub's.

Returns:

a name which overrides the name of the annotated one, may be used in cases such as constructors or ambiguous functions

Since:

0.5.0

Default:

""

strict

public abstract boolean strict

When set to false, tells the processor to first try to match a single method by name, and to only check parameters if further clarification is needed. While non-strict mode is more computationally efficient, it's ultimately not relevant, as it only matters at compile time. Do not set this to false unless you know what you're doing.

Returns:

whether strict mode is to be used

Since:

0.3.0

Default:

true

bridge

public abstract boolean bridge

When set to true, tells the processor to try to match the synthetic "bridge" method generated by the compiler to handle type erasure.

Returns:

whether the bridge method should be targeted instead of the actual method

Since:

0.5.2

Default:

false

lookForParent

@Deprecated
public abstract boolean lookForParent

Deprecated. This is meant as a temporary workaround and will be removed in an upcoming patch as better logic for parent-lookup in mappings is introduced. When that happens, setting this to false will be rendered moot, so you can just remove this from your annotations.

When set to true, tells the processor to try and match the top-level parent of this method. This is the behaviour you want in *most* cases, as it will be either irrelevant or beneficial. In some particularly elaborate cases of inheritance with type erasure, you may want to explicitly specify the top-level parent with Overridden or, if your mappings are specific enough, to merely disable this.

Returns:

whether to try and match the top-level parent

Since:

0.8.0

Default:

true