Package com.cosylab.vdct.plugin.config
Interface NameConfigPlugin
-
- All Superinterfaces:
Plugin
- All Known Implementing Classes:
NameConfigExample
public interface NameConfigPlugin extends Plugin
- Author:
- ssah
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringcheckValidity(String name)If name is valid, the function returns null, otherwise it returns a String with the description of the error.StringgetDefaultName()Returns the default name.StringgetNameDescription()Returns the description of the valid names.booleanisRunning()Returns true if the plugin has not been stopped since the last start.-
Methods inherited from interface com.cosylab.vdct.plugin.Plugin
destroy, getAuthor, getDescription, getName, getVersion, init, start, stop
-
-
-
-
Method Detail
-
checkValidity
String checkValidity(String name)
If name is valid, the function returns null, otherwise it returns a String with the description of the error.- Parameters:
name- name- Returns:
- something
-
getNameDescription
String getNameDescription()
Returns the description of the valid names. Can be null.- Returns:
- something
-
getDefaultName
String getDefaultName()
Returns the default name. Can be null.- Returns:
- something
-
isRunning
boolean isRunning()
Returns true if the plugin has not been stopped since the last start.- Returns:
- something
-
-