Module org.spongepowered.eventimplgen

Package org.spongepowered.eventimplgen.eventgencore

Class Property

java.lang.Object

org.spongepowered.eventimplgen.eventgencore.Property

All Implemented Interfaces:

Comparable<Property>

public final class Property
extends Object
implements Comparable<Property>

A property is a getter with possibly a setter pair.

Constructor Summary

Constructors

Constructor	Description
Property(String name, TypeMirror type, ExecutableElement leastSpecificMethod, ExecutableElement mostSpecificMethod, ExecutableElement accessor, @Nullable ExecutableElement mutator)	Create a new property.

Method Summary

Modifier and Type	Method	Description
int	compareTo(Property other)
ExecutableElement	getAccessor()	Get the method representing the accessor.
ExecutableElement	getAccessorWrapper()
ExecutableElement	getLeastSpecificMethod()	Gets the least specific version of the accessor used.
TypeMirror	getLeastSpecificType()	Gets the least specific version of the type used
ExecutableElement	getMostSpecificMethod()	Get the most specific version of the accessor used.
TypeMirror	getMostSpecificType()	Gets the most specific version of the type used
Optional<ExecutableElement>	getMutator()	Get the method representing the mutator, which or may not exist.
String	getName()	Get the name of the property.
TypeMirror	getType()	Get the type of the paramteer.
TypeMirror	getWrapperType()
boolean	isLeastSpecificType(Types types)	Tests whether this property's type is the least specific version used in the interface hierarchy.
boolean	isMostSpecificType(Types types)

Methods inherited from class java.lang.Object

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

Constructor Details

Property

public Property(String name,
 TypeMirror type,
 ExecutableElement leastSpecificMethod,
 ExecutableElement mostSpecificMethod,
 ExecutableElement accessor,
 @Nullable
 @Nullable ExecutableElement mutator)

Create a new property.

Parameters:

name - The name of the property

type - The type of property

leastSpecificMethod - The least specific method

accessor - The accessor

mutator - The mutator

Method Details

getName

public String getName()

Get the name of the property.

Returns:

The name

getType

public TypeMirror getType()

Get the type of the paramteer.

Returns:

The type

getWrapperType

public TypeMirror getWrapperType()

getLeastSpecificMethod

public ExecutableElement getLeastSpecificMethod()

Gets the least specific version of the accessor used.

Returns:

The least specific accessor

getLeastSpecificType

public TypeMirror getLeastSpecificType()

Gets the least specific version of the type used

This is used for the type of the generated field used to hold the value.

Returns:

The type

getMostSpecificMethod

public ExecutableElement getMostSpecificMethod()

Get the most specific version of the accessor used.

Returns:

The least specific accessor

getMostSpecificType

public TypeMirror getMostSpecificType()

Gets the most specific version of the type used

Returns:

The type

getAccessor

public ExecutableElement getAccessor()

Get the method representing the accessor.

Returns:

The accessor

getAccessorWrapper

public ExecutableElement getAccessorWrapper()

getMutator

public Optional<ExecutableElement> getMutator()

Get the method representing the mutator, which or may not exist.

Returns:

The mutator

isLeastSpecificType

public boolean isLeastSpecificType(Types types)

Tests whether this property's type is the least specific version used in the interface hierarchy.

Returns:

True if tis property's type is the least specific

isMostSpecificType

public boolean isMostSpecificType(Types types)

compareTo

public int compareTo(Property other)

Specified by:

compareTo in interface Comparable<Property>