org.openstreetmap.josm.plugins

Class PluginHandler.DeprecatedPlugin

java.lang.Object

org.openstreetmap.josm.plugins.PluginHandler.DeprecatedPlugin

All Implemented Interfaces:

java.lang.Comparable<PluginHandler.DeprecatedPlugin>

Enclosing class:

PluginHandler

public static class PluginHandler.DeprecatedPlugin
extends java.lang.Object
implements java.lang.Comparable<PluginHandler.DeprecatedPlugin>

Description of a deprecated plugin

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Runnable	migration Code to run to perform migration, can be null
java.lang.String	name Plugin name
java.lang.String	reason Short explanation about deprecation, can be null

Constructor Summary

Constructors

Constructor and Description
DeprecatedPlugin(java.lang.String name) Constructs a new DeprecatedPlugin.
DeprecatedPlugin(java.lang.String name, java.lang.String reason) Constructs a new DeprecatedPlugin with a given reason.
DeprecatedPlugin(java.lang.String name, java.lang.String reason, java.lang.Runnable migration) Constructs a new DeprecatedPlugin.

Method Summary

Modifier and Type	Method and Description
int	compareTo(PluginHandler.DeprecatedPlugin o)
void	migrate() Performs migration.

Methods inherited from class java.lang.Object

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

Field Detail

name

public final java.lang.String name

Plugin name

reason

public final java.lang.String reason

Short explanation about deprecation, can be null

migration

private final java.lang.Runnable migration

Code to run to perform migration, can be null

Constructor Detail

DeprecatedPlugin

public DeprecatedPlugin(java.lang.String name)

Constructs a new DeprecatedPlugin.

Parameters:

name - The plugin name

DeprecatedPlugin

public DeprecatedPlugin(java.lang.String name,
                        java.lang.String reason)

Constructs a new DeprecatedPlugin with a given reason.

Parameters:

name - The plugin name

reason - The reason about deprecation

DeprecatedPlugin

public DeprecatedPlugin(java.lang.String name,
                        java.lang.String reason,
                        java.lang.Runnable migration)

Constructs a new DeprecatedPlugin.

Parameters:

name - The plugin name

reason - The reason about deprecation

migration - The code to run to perform migration

Method Detail

migrate

public void migrate()

Performs migration.

compareTo

public int compareTo(PluginHandler.DeprecatedPlugin o)

Specified by:

compareTo in interface java.lang.Comparable<PluginHandler.DeprecatedPlugin>