PluginData (Plan 3.1.1 API)

java.lang.Object
- main.java.com.djrapitops.plan.data.additional.PluginData

Direct Known Subclasses:

AdvancedAchievementsAchievements, AdvancedAchievementsTable, EconomyBalance, EssentialsJailed, EssentialsMuted, EssentialsWarps, FactionsFaction, FactionsMaxPower, FactionsPower, FactionsTable, OntimeRefer, OntimeReferMonth, OntimeReferWeek, OntimeVotes, OntimeVotesMonth, OntimeVotesWeek, TownyTable, TownyTown
```
public abstract class PluginData
extends Object
```
This is an abstract class that can be used to add data from a plugin to the "Plugins"-tab of Analysis and Inspect pages. API-section of documentation has examples on the usage of this class and how to register objects extending this class.

Since:

3.1.0

Author:

Rsl1122

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`analysisOnly` Determines if the datapoint should only be used for the analysis page.
`protected List<AnalysisType>`	`analysisTypes` A list containing the AnalysisType enums that determine what should be done with the data on the analysis page.
`protected String`	`icon` Font Awesome icon name.
`protected String`	`placeholder` Placeholder string, for example "stepsTaken".
`protected String`	`prefix` Prefix shown before the data, for example "Steps taken: ".
`protected String`	`sourcePlugin` Name of the plugin the data is coming from.
`protected String`	`suffix` Suffix shown after the data, for example " steps".

Constructor Summary

Constructors
Constructor and Description
`PluginData(String sourcePlugin, String placeholder)` Constructor for Inspect-page only data point.
`PluginData(String sourcePlugin, String placeholder, AnalysisType... analysisTypes)` Constructor for accepting single, multiple and arrays of AnalysisType.
`PluginData(String sourcePlugin, String placeholder, List<AnalysisType> analysisTypes)` Main constructor.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`analysisOnly()` Used to get the analysisOnly parameter.
`boolean`	`equals(Object obj)` If a PluginData object has same placeholder, sourcePlugin and analysisTypes, it is considired equal.
`List<AnalysisType>`	`getAnalysisTypes()` Returns the list of AnalysisTypes.
`abstract String`	`getHtmlReplaceValue(String modifierPrefix, UUID uuid)` Used to get the string for the html page.
`String`	`getPlaceholder(String modifier)` Used to get the full placeholder.
`String`	`getPrefix()` Used to get the prefix.
`String`	`getSourcePlugin()` Used to get the source plugin's name.
`String`	`getSuffix()` Used to get the suffix.
`abstract Serializable`	`getValue(UUID uuid)` Used to get the value for analysis.
`int`	`hashCode()`
`String`	`parseContainer(String modifier, String contents)` This method should be used with the return values of getHtmlReplaceValue(String, UUID).
`void`	`setAnalysisOnly(boolean analysisOnly)` Used to set the analysisOnly parameter.
`void`	`setIcon(String iconName)` Used to set the Font Awesome icon.
`void`	`setPrefix(String prefix)` Used to set the prefix.
`void`	`setSuffix(String suffix)` Used to set the suffix.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - placeholder
```
protected String placeholder
```
    Placeholder string, for example "stepsTaken". This will be used when building the structure of the Plugins tab. The complete placeholder also includes the plugin name and if analysis is run, a modifier. Second parameter of any super constructor.
  - sourcePlugin
```
protected String sourcePlugin
```
    Name of the plugin the data is coming from. All datasources with the same sourcePlugin will be placed in the same "box" in the "Plugins" tab. A box has a max height of 600px, and higher than that will add a scrollbar. First parameter of any super constructor.
  - analysisOnly
```
protected boolean analysisOnly
```
    Determines if the datapoint should only be used for the analysis page. If set to false, the datapoint will be added to the inspect page as well.
  - icon
```
protected String icon
```
    Font Awesome icon name. http://fontawesome.io/icons/
  - prefix
```
protected String prefix
```
    Prefix shown before the data, for example "Steps taken: ".
  - suffix
```
protected String suffix
```
    Suffix shown after the data, for example " steps".
  - analysisTypes
```
protected List<AnalysisType> analysisTypes
```
    A list containing the AnalysisType enums that determine what should be done with the data on the analysis page.
- Constructor Detail
  - PluginData
```
public PluginData(String sourcePlugin,
                  String placeholder,
                  List<AnalysisType> analysisTypes)
```
    Main constructor. Defaults analysisOnly to true. Defaults icon, prefix and suffix to "".
    
    Parameters:
    
    sourcePlugin - Name of the plugin the data is coming from
    
    placeholder - Placeholder string, for example "stepsTaken"
    
    analysisTypes - A list containing the AnalysisType enums that determine what should be done with the data on the analysis page
  - PluginData
```
public PluginData(String sourcePlugin,
                  String placeholder,
                  AnalysisType... analysisTypes)
```
    Constructor for accepting single, multiple and arrays of AnalysisType.
    
    Parameters:
    
    sourcePlugin - Name of the plugin the data is coming from
    
    placeholder - Placeholder string, for example "stepsTaken"
    
    analysisTypes - AnalysisType enums that determine what should be done with the data on the analysis page
  - PluginData
```
public PluginData(String sourcePlugin,
                  String placeholder)
```
    Constructor for Inspect-page only data point. analysisOnly will be set to false.
    
    Parameters:
    
    sourcePlugin - Name of the plugin the data is coming from
    
    placeholder - Placeholder string, for example "stepsTaken"
- Method Detail
  - getAnalysisTypes
```
public final List<AnalysisType> getAnalysisTypes()
```
    Returns the list of AnalysisTypes. Used by Analysis
    
    Returns:
    
    a list.
  - parseContainer
```
public final String parseContainer(String modifier,
                                   String contents)
```
    This method should be used with the return values of getHtmlReplaceValue(String, UUID). It will add the div, icon, modifier, prefix and suffix to the value. Modifier is for example, if calculating AnalysisType.INT_AVG "Average ", it is a text that helps user understand that a calculation has been made.
    
    Parameters:
    
    modifier - For example "Average " - Determined by value of AnalysisType's modifier-variable.
    
    contents - The data, number/string/html that should be placed on the page.
    
    Returns:
    
    a proper format for the html.
    
    See Also:
    
    AnalysisType
  - getPlaceholder
```
public final String getPlaceholder(String modifier)
```
    Used to get the full placeholder. Used to avoid conflicts with existing placeholders and placeholders of other plugins.
    
    Parameters:
    
    modifier - Modifier determined by AnalysisType's placeholderModifier-variable.
    
    Returns:
    
    for example "%StepCounter_stepsTaken_total%"
    
    See Also:
    
    AnalysisType
  - getSourcePlugin
```
public final String getSourcePlugin()
```
    Used to get the source plugin's name.
    
    Returns:
    
    for example "StepCounter"
  - getHtmlReplaceValue
```
public abstract String getHtmlReplaceValue(String modifierPrefix,
                                           UUID uuid)
```
    Used to get the string for the html page. parseContainer(modifierPrefix, value); should be used for all return values so that div, icon, prefix and suffix are added. This method is used when AnalysisType.HTML is set, or while getting the value for the inspect page. When using AnalysisType.HTML a random UUID is given, so it should be disregarded. modifierPrefix is empty in that case.
    
    Parameters:
    
    modifierPrefix - Modifier determined by AnalysisType's modifier-variable.
    
    uuid - UUID of the player or random UUID if AnalysisType.HTML is used.
    
    Returns:
    
    html for the page.
  - getValue
```
public abstract Serializable getValue(UUID uuid)
```
    Used to get the value for analysis. The return value is determined by AnalysisType you have specified. If the AnalysisType's name has a BOOLEAN in it, Analysis will expect boolean values etc. If the Type and return value mismatch, exception is thrown and the result on the analysis page will say that error occurred as the value. If a player has no value a -1 should be returned in the case of a Number. -1 is excluded from the Average calculation's size and total.
    
    Parameters:
    
    uuid - UUID of the player the value belongs to.
    
    Returns:
    
    Long, Integer, Double, Boolean or String, return -1 if the player has no value.
  - setPrefix
```
public final void setPrefix(String prefix)
```
    Used to set the prefix.
    
    Parameters:
    
    prefix - for example "Steps Taken: " or a Html start tag.
  - setSuffix
```
public final void setSuffix(String suffix)
```
    Used to set the suffix.
    
    Parameters:
    
    suffix - for example " steps" or a html end tag.
  - setIcon
```
public final void setIcon(String iconName)
```
    Used to set the Font Awesome icon.
    
    Parameters:
    
    iconName - Icon's name http://fontawesome.io/icons/
  - setAnalysisOnly
```
public final void setAnalysisOnly(boolean analysisOnly)
```
    Used to set the analysisOnly parameter. true: only used for Analysis page false: used for both if AnalysisTypes specified, if no AnalysisTypes are specified only used for Inspect page.
    
    Parameters:
    
    analysisOnly - true/false
  - analysisOnly
```
public final boolean analysisOnly()
```
    Used to get the analysisOnly parameter.
    
    Returns:
    
    true/false
  - getPrefix
```
public final String getPrefix()
```
    Used to get the prefix.
    
    Returns:
    
    example: "Steps Taken "
  - getSuffix
```
public final String getSuffix()
```
    Used to get the suffix.
    
    Returns:
    
    example: " steps"
  - equals
```
public final boolean equals(Object obj)
```
    If a PluginData object has same placeholder, sourcePlugin and analysisTypes, it is considired equal.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - Another Object.
    
    Returns:
    
    Is current object equal to given object.
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class PluginData

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

placeholder

sourcePlugin

analysisOnly

icon

prefix

suffix

analysisTypes

Constructor Detail

PluginData

PluginData

PluginData

Method Detail

getAnalysisTypes

parseContainer

getPlaceholder

getSourcePlugin

getHtmlReplaceValue

getValue

setPrefix

setSuffix

setIcon

setAnalysisOnly

analysisOnly

getPrefix

getSuffix

equals

hashCode