Package com.hypixel.hytale.common.plugin

Class PluginManifest

java.lang.Object

com.hypixel.hytale.common.plugin.PluginManifest

public class PluginManifest
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PluginManifest.CoreBuilder

Field Summary

Fields

Modifier and Type	Field	Description
static final Codec<PluginManifest[]>	ARRAY_CODEC
private List<AuthorInfo>	authors
private static final BuilderCodec.Builder<PluginManifest>	BUILDER
static final Codec<PluginManifest>	CODEC
private static final String	CORE_GROUP
private static final Semver	CORE_VERSION
private Map<PluginIdentifier,SemverRange>	dependencies
private String	description
private boolean	disabledByDefault
private String	group
private boolean	includesAssetPack
private Map<PluginIdentifier,SemverRange>	loadBefore
private String	main
private String	name
private Map<PluginIdentifier,SemverRange>	optionalDependencies
private SemverRange	serverVersion
private List<PluginManifest>	subPlugins
private Semver	version
private String	website

Constructor Summary

Constructors

Constructor	Description
PluginManifest()
PluginManifest(String group, String name, Semver version, String description, List<AuthorInfo> authors, String website, String main, SemverRange serverVersion, Map<PluginIdentifier,SemverRange> dependencies, Map<PluginIdentifier,SemverRange> optionalDependencies, Map<PluginIdentifier,SemverRange> loadBefore, List<PluginManifest> subPlugins, boolean disabledByDefault)

Method Summary

Modifier and Type	Method	Description
static PluginManifest.CoreBuilder	corePlugin(Class<?> pluginClass)
List<AuthorInfo>	getAuthors()
Map<PluginIdentifier,SemverRange>	getDependencies()
String	getDescription()
String	getGroup()
Map<PluginIdentifier,SemverRange>	getLoadBefore()
String	getMain()
String	getName()
Map<PluginIdentifier,SemverRange>	getOptionalDependencies()
SemverRange	getServerVersion()
List<PluginManifest>	getSubPlugins()
Semver	getVersion()
String	getWebsite()
boolean	includesAssetPack()
void	inherit(PluginManifest manifest)
void	injectDependency(PluginIdentifier identifier, SemverRange range)
boolean	isDisabledByDefault()
void	setAuthors(List<AuthorInfo> authors)
void	setDescription(String description)
void	setGroup(String group)
void	setName(String name)
void	setVersion(Semver version)
void	setWebsite(String website)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

BUILDER

@Nonnull
private static final BuilderCodec.Builder<PluginManifest> BUILDER

CODEC

@Nonnull
public static final Codec<PluginManifest> CODEC

ARRAY_CODEC

@Nonnull
public static final Codec<PluginManifest[]> ARRAY_CODEC

CORE_GROUP

private static final String CORE_GROUP

See Also:

• Constant Field Values

CORE_VERSION

private static final Semver CORE_VERSION

group

private String group

name

private String name

version

private Semver version

description

@Nullable
private String description

authors

@Nonnull
private List<AuthorInfo> authors

website

@Nullable
private String website

main

@Nullable
private String main

serverVersion

private SemverRange serverVersion

dependencies

@Nonnull
private Map<PluginIdentifier,SemverRange> dependencies

optionalDependencies

@Nonnull
private Map<PluginIdentifier,SemverRange> optionalDependencies

loadBefore

@Nonnull
private Map<PluginIdentifier,SemverRange> loadBefore

subPlugins

@Nonnull
private List<PluginManifest> subPlugins

disabledByDefault

private boolean disabledByDefault

includesAssetPack

private boolean includesAssetPack

Constructor Details

PluginManifest

public PluginManifest()

PluginManifest

public PluginManifest(@Nonnull
 String group,
 @Nonnull
 String name,
 @Nonnull
 Semver version,
 @Nullable
 String description,
 @Nonnull
 List<AuthorInfo> authors,
 @Nullable
 String website,
 @Nullable
 String main,
 @Nullable
 SemverRange serverVersion,
 @Nonnull
 Map<PluginIdentifier,SemverRange> dependencies,
 @Nonnull
 Map<PluginIdentifier,SemverRange> optionalDependencies,
 @Nonnull
 Map<PluginIdentifier,SemverRange> loadBefore,
 @Nonnull
 List<PluginManifest> subPlugins,
 boolean disabledByDefault)

Method Details

getGroup

public String getGroup()

getName

public String getName()

getVersion

public Semver getVersion()

getDescription

@Nullable
public String getDescription()

getAuthors

@Nonnull
public List<AuthorInfo> getAuthors()

getWebsite

@Nullable
public String getWebsite()

setGroup

public void setGroup(@Nonnull
 String group)

setName

public void setName(@Nonnull
 String name)

setVersion

public void setVersion(@Nullable
 Semver version)

setDescription

public void setDescription(@Nullable
 String description)

setAuthors

public void setAuthors(@Nonnull
 List<AuthorInfo> authors)

setWebsite

public void setWebsite(@Nullable
 String website)

getMain

@Nullable
public String getMain()

getServerVersion

public SemverRange getServerVersion()

getDependencies

@Nonnull
public Map<PluginIdentifier,SemverRange> getDependencies()

injectDependency

public void injectDependency(PluginIdentifier identifier,
 SemverRange range)

getOptionalDependencies

@Nonnull
public Map<PluginIdentifier,SemverRange> getOptionalDependencies()

getLoadBefore

@Nonnull
public Map<PluginIdentifier,SemverRange> getLoadBefore()

isDisabledByDefault

public boolean isDisabledByDefault()

includesAssetPack

public boolean includesAssetPack()

getSubPlugins

@Nonnull
public List<PluginManifest> getSubPlugins()

inherit

public void inherit(@Nonnull
 PluginManifest manifest)

toString

@Nonnull
public String toString()

Overrides:

toString in class Object

corePlugin

@Nonnull
public static PluginManifest.CoreBuilder corePlugin(@Nonnull
 Class<?> pluginClass)