Package org.elasticsearch.plugins

Class MetaPluginInfo

java.lang.Object

org.elasticsearch.plugins.MetaPluginInfo

public class MetaPluginInfo
extends java.lang.Object

An in-memory representation of the meta plugin descriptor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
java.lang.String	getDescription()	The description of the meta plugin.
java.lang.String	getName()	The name of the meta plugin.
int	hashCode()
static boolean	isMetaPlugin(java.nio.file.Path path)
static boolean	isPropertiesFile(java.nio.file.Path path)
static MetaPluginInfo	readFromProperties(java.nio.file.Path path)	Reads and validates the meta plugin descriptor file.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

isMetaPlugin

public static boolean isMetaPlugin(java.nio.file.Path path)

Returns:

Whether the provided path is a meta plugin.

isPropertiesFile

public static boolean isPropertiesFile(java.nio.file.Path path)

Returns:

Whether the provided path is a meta properties file.

readFromProperties

public static MetaPluginInfo readFromProperties(java.nio.file.Path path)
                                         throws java.io.IOException

Reads and validates the meta plugin descriptor file.

Parameters:

path - the path to the root directory for the meta plugin

Returns:

the meta plugin info

Throws:

java.io.IOException - if an I/O exception occurred reading the meta plugin descriptor

getName

public java.lang.String getName()

The name of the meta plugin.

Returns:

the meta plugin name

getDescription

public java.lang.String getDescription()

The description of the meta plugin.

Returns:

the meta plugin description

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object