Plugin

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> cgsuite >> [ plugin overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

SOURCE |

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

cgsuite.plugin
Interface Plugin

public interface Plugin

Exposes a plug-in package to the Combinatorial Game Suite user interface.

Every plug-in package must include a class that implements Plugin. Immediately after a plug-in is loaded, an instance of that class is created and its initialize 55 method is invoked. Types, constants, methods and output handlers should be declared during the call to initialize, by calling back to the supplied PluginContext.

It is advisable to use a single implementation of Plugin to declare all classes in a plug-in package. For example, if a package includes three subclasses of Game, then all three can be declared by a single Plugin implementation.

Version:: 0.1.1

Method Summary

PluginInfo getPluginInfo()
Gets basic information about this plug-in package.

void initialize(PluginContext pluginContext)
Declares types, constants, methods and output handlers for this plug-in.

Method Detail

initialize

public void initialize(PluginContext pluginContext)

Declares types, constants, methods and output handlers for this plug-in.

getPluginInfo

public PluginInfo getPluginInfo()

Gets basic information about this plug-in package.