PluginManifest (SonarSource :: Update Center

java.lang.Object
- org.sonar.updatecenter.common.PluginManifest

```
public final class PluginManifest
extends Object
```
This class loads Sonar plugin metadata from JAR manifest.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BASE_PLUGIN`
`static String`	`BUILD_DATE`
`static String`	`DEPENDENCIES`
`static String`	`DESCRIPTION`
`static String`	`DEVELOPERS`
`static String`	`DISPLAY_VERSION`
`static String`	`HOMEPAGE`
`static String`	`IMPLEMENTATION_BUILD`
`static String`	`ISSUE_TRACKER_URL`
`static String`	`KEY`
`static String`	`LICENSE`
`static String`	`MAIN_CLASS`
`static String`	`NAME`
`static String`	`ORGANIZATION`
`static String`	`ORGANIZATION_URL`
`static String`	`REQUIRE_PLUGINS`
`static String`	`SONAR_VERSION`
`static String`	`SONARLINT_SUPPORTED`
`static String`	`SOURCES_URL`
`static String`	`TERMS_CONDITIONS_URL`
`static String`	`USE_CHILD_FIRST_CLASSLOADER`
`static String`	`VERSION`

Constructor Summary

Constructors
Constructor and Description

PluginManifest()

PluginManifest(File file)
Load the manifest from a JAR file.

PluginManifest(Manifest manifest)

Constructors
Constructor and Description
`PluginManifest()`
`PluginManifest(File file)` Load the manifest from a JAR file.
`PluginManifest(Manifest manifest)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getBasePlugin()`
`Date`	`getBuildDate()`
`String[]`	`getDependencies()`
`String`	`getDescription()`
`String[]`	`getDevelopers()`
`String`	`getDisplayVersion()`
`String`	`getHomepage()`
`String`	`getImplementationBuild()`
`String`	`getIssueTrackerUrl()`
`String`	`getKey()`
`String`	`getLicense()`
`String`	`getMainClass()`
`String`	`getName()`
`String`	`getOrganization()`
`String`	`getOrganizationUrl()`
`String[]`	`getRequirePlugins()`
`String`	`getSonarVersion()`
`String`	`getSourcesUrl()`
`String`	`getTermsConditionsUrl()`
`String`	`getVersion()`
`boolean`	`isSonarLintSupported()`
`boolean`	`isUseChildFirstClassLoader()`
`boolean`	`isValid()`
`PluginManifest`	`setBasePlugin(String key)`
`PluginManifest`	`setBuildDate(Date buildDate)`
`PluginManifest`	`setDependencies(String[] dependencies)`
`PluginManifest`	`setDescription(String description)`
`PluginManifest`	`setDevelopers(String[] developers)`
`PluginManifest`	`setDisplayVersion(String displayVersion)`
`PluginManifest`	`setHomepage(String homepage)`
`PluginManifest`	`setImplementationBuild(String implementationBuild)`
`PluginManifest`	`setIssueTrackerUrl(String issueTrackerUrl)`
`PluginManifest`	`setKey(String key)`
`PluginManifest`	`setLicense(String license)`
`PluginManifest`	`setMainClass(String mainClass)`
`PluginManifest`	`setName(String name)`
`PluginManifest`	`setOrganization(String organization)`
`PluginManifest`	`setOrganizationUrl(String url)`
`PluginManifest`	`setRequirePlugins(String[] requirePlugins)`
`PluginManifest`	`setSonarLintSupported(boolean sonarlintSupported)`
`PluginManifest`	`setSonarVersion(String sonarVersion)`
`PluginManifest`	`setSourcesUrl(String sourcesUrl)`
`PluginManifest`	`setTermsConditionsUrl(String termsConditionsUrl)`
`PluginManifest`	`setUseChildFirstClassLoader(boolean useChildFirstClassLoader)`
`PluginManifest`	`setVersion(String version)`
`String`	`toString()`

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

Field Detail
- KEY
```
public static final String KEY
```
  See Also:
  
  Constant Field Values
- MAIN_CLASS
```
public static final String MAIN_CLASS
```
  See Also:
  
  Constant Field Values
- NAME
```
public static final String NAME
```
  See Also:
  
  Constant Field Values
- DESCRIPTION
```
public static final String DESCRIPTION
```
  See Also:
  
  Constant Field Values
- ORGANIZATION
```
public static final String ORGANIZATION
```
  See Also:
  
  Constant Field Values
- ORGANIZATION_URL
```
public static final String ORGANIZATION_URL
```
  See Also:
  
  Constant Field Values
- LICENSE
```
public static final String LICENSE
```
  See Also:
  
  Constant Field Values
- VERSION
```
public static final String VERSION
```
  See Also:
  
  Constant Field Values
- SONAR_VERSION
```
public static final String SONAR_VERSION
```
  See Also:
  
  Constant Field Values
- DEPENDENCIES
```
public static final String DEPENDENCIES
```
  See Also:
  
  Constant Field Values
- HOMEPAGE
```
public static final String HOMEPAGE
```
  See Also:
  
  Constant Field Values
- TERMS_CONDITIONS_URL
```
public static final String TERMS_CONDITIONS_URL
```
  See Also:
  
  Constant Field Values
- BUILD_DATE
```
public static final String BUILD_DATE
```
  See Also:
  
  Constant Field Values
- ISSUE_TRACKER_URL
```
public static final String ISSUE_TRACKER_URL
```
  See Also:
  
  Constant Field Values
- REQUIRE_PLUGINS
```
public static final String REQUIRE_PLUGINS
```
  See Also:
  
  Constant Field Values
- USE_CHILD_FIRST_CLASSLOADER
```
public static final String USE_CHILD_FIRST_CLASSLOADER
```
  Since:
  
  0.3
  
  See Also:
  
  Constant Field Values
- BASE_PLUGIN
```
public static final String BASE_PLUGIN
```
  Since:
  
  1.1
  
  See Also:
  
  Constant Field Values
- IMPLEMENTATION_BUILD
```
public static final String IMPLEMENTATION_BUILD
```
  Since:
  
  1.3
  
  See Also:
  
  Constant Field Values
- SOURCES_URL
```
public static final String SOURCES_URL
```
  Since:
  
  1.4
  
  See Also:
  
  Constant Field Values
- DEVELOPERS
```
public static final String DEVELOPERS
```
  Since:
  
  1.4
  
  See Also:
  
  Constant Field Values
- SONARLINT_SUPPORTED
```
public static final String SONARLINT_SUPPORTED
```
  Since:
  
  1.16
  
  See Also:
  
  Constant Field Values
- DISPLAY_VERSION
```
public static final String DISPLAY_VERSION
```
  Since:
  
  1.18
  
  See Also:
  
  Constant Field Values

Constructor Detail
- PluginManifest
```
public PluginManifest(File file)
               throws IOException
```
  Load the manifest from a JAR file.
  
  Throws:
  
  IOException
- PluginManifest
```
public PluginManifest(Manifest manifest)
```
  Parameters:
  
  manifest - can not be null
- PluginManifest
```
public PluginManifest()
```

Method Detail

getKey
```
public String getKey()
```

setKey

public PluginManifest setKey(String key)

getName
```
public String getName()
```

setName

public PluginManifest setName(String name)

getRequirePlugins
```
public String[] getRequirePlugins()
```
Since:

3.5

setRequirePlugins

public PluginManifest setRequirePlugins(@Nullable
                                        String[] requirePlugins)

Since:: 3.5

getDescription
```
public String getDescription()
```

setDescription

public PluginManifest setDescription(String description)

getOrganization
```
public String getOrganization()
```

setOrganization

public PluginManifest setOrganization(String organization)

getOrganizationUrl
```
public String getOrganizationUrl()
```

setOrganizationUrl

public PluginManifest setOrganizationUrl(String url)

getLicense
```
public String getLicense()
```

setLicense

public PluginManifest setLicense(String license)

getVersion
```
public String getVersion()
```

setVersion

public PluginManifest setVersion(String version)

getDisplayVersion
```
public String getDisplayVersion()
```

setDisplayVersion

public PluginManifest setDisplayVersion(String displayVersion)

getSonarVersion
```
public String getSonarVersion()
```

setSonarVersion

public PluginManifest setSonarVersion(String sonarVersion)

getMainClass
```
public String getMainClass()
```

setMainClass

public PluginManifest setMainClass(String mainClass)

getDependencies
```
public String[] getDependencies()
```

setDependencies

public PluginManifest setDependencies(@Nullable
                                      String[] dependencies)

getBuildDate
```
public Date getBuildDate()
```

setBuildDate

public PluginManifest setBuildDate(@Nullable
                                   Date buildDate)

getHomepage
```
public String getHomepage()
```

setHomepage

public PluginManifest setHomepage(String homepage)

getTermsConditionsUrl
```
public String getTermsConditionsUrl()
```

setTermsConditionsUrl

public PluginManifest setTermsConditionsUrl(String termsConditionsUrl)

getIssueTrackerUrl
```
public String getIssueTrackerUrl()
```

setIssueTrackerUrl

public PluginManifest setIssueTrackerUrl(String issueTrackerUrl)

isUseChildFirstClassLoader

public boolean isUseChildFirstClassLoader()

Since:: 0.3

setUseChildFirstClassLoader

public PluginManifest setUseChildFirstClassLoader(boolean useChildFirstClassLoader)

Since:: 0.3

isSonarLintSupported
```
public boolean isSonarLintSupported()
```
Since:

1.16

setSonarLintSupported

public PluginManifest setSonarLintSupported(boolean sonarlintSupported)

Since:: 1.16

getBasePlugin
```
public String getBasePlugin()
```
Since:

1.1

setBasePlugin

public PluginManifest setBasePlugin(String key)

Since:: 1.1

getImplementationBuild

public String getImplementationBuild()

Since:: 1.3

setImplementationBuild

public PluginManifest setImplementationBuild(String implementationBuild)

Since:: 1.3

getSourcesUrl
```
public String getSourcesUrl()
```
Since:

1.4

setSourcesUrl

public PluginManifest setSourcesUrl(String sourcesUrl)

Since:: 1.4

getDevelopers
```
public String[] getDevelopers()
```
Since:

1.4

setDevelopers

public PluginManifest setDevelopers(String[] developers)

Since:: 1.4

toString
```
public String toString()
```
Overrides:

toString in class Object

isValid
```
public boolean isValid()
```

Class PluginManifest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

KEY

MAIN_CLASS

NAME

DESCRIPTION

ORGANIZATION

ORGANIZATION_URL

LICENSE

VERSION

SONAR_VERSION

DEPENDENCIES

HOMEPAGE

TERMS_CONDITIONS_URL

BUILD_DATE

ISSUE_TRACKER_URL

REQUIRE_PLUGINS

USE_CHILD_FIRST_CLASSLOADER

BASE_PLUGIN

IMPLEMENTATION_BUILD

SOURCES_URL

DEVELOPERS

SONARLINT_SUPPORTED

DISPLAY_VERSION

Constructor Detail

PluginManifest

PluginManifest

PluginManifest

Method Detail

getKey

setKey

getName

setName

getRequirePlugins

setRequirePlugins

getDescription

setDescription

getOrganization

setOrganization

getOrganizationUrl

setOrganizationUrl

getLicense

setLicense

getVersion

setVersion

getDisplayVersion

setDisplayVersion

getSonarVersion

setSonarVersion

getMainClass

setMainClass

getDependencies

setDependencies

getBuildDate

setBuildDate

getHomepage

setHomepage

getTermsConditionsUrl

setTermsConditionsUrl

getIssueTrackerUrl

setIssueTrackerUrl

isUseChildFirstClassLoader

setUseChildFirstClassLoader

isSonarLintSupported

setSonarLintSupported

getBasePlugin

setBasePlugin

getImplementationBuild

setImplementationBuild

getSourcesUrl

setSourcesUrl

getDevelopers

setDevelopers

toString

isValid