Module org.spongepowered.eventimplgen

Package org.spongepowered.eventimplgen.factory.plugin

Interface EventFactoryPlugin

All Known Implementing Classes:

AccessorModifierEventFactoryPlugin

public interface EventFactoryPlugin

Represents a class which modifies the behavior of an event generator.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	EventFactoryPlugin.Result

Method Summary

Modifier and Type	Method	Description
EventFactoryPlugin.Result	contributeProperty(TypeElement eventClass, ClassContext classWriter, Property property)	Called to allow a plugin to override the generation of the field and method(s) for a Property.

Method Details

contributeProperty

EventFactoryPlugin.Result contributeProperty(TypeElement eventClass,
 ClassContext classWriter,
 Property property)

Called to allow a plugin to override the generation of the field and method(s) for a Property.

If an event factory plugin does not have any special behavior for the provided Property, it should return false, which passes on the property to other plugins for processing.

Returning true stops the processing of the provided Property.

Parameters:

eventClass - The Class of the event an implementation is being generated for

classWriter - The ClassContext holding information about the implementation class

property - The Property being processed

Returns:

whether the provided Property was processed.