co.cask.cdap.proto

Class DatasetModuleMeta

java.lang.Object

co.cask.cdap.proto.DatasetModuleMeta

public class DatasetModuleMeta
extends Object

Dataset module meta data

Constructor Summary

Constructors

Constructor and Description
DatasetModuleMeta(String name, String className, URI jarLocation, List<String> types, List<String> usesModules) Creates instance of DatasetModuleMeta

Method Summary

Methods

Modifier and Type	Method and Description
void	addUsedByModule(String name) Adds module to the list of dependant modules
String	getClassName()
URI	getJarLocation()
String	getName()
List<String>	getTypes()
Collection<String>	getUsedByModules()
List<String>	getUsesModules()
void	removeUsedByModule(String name) Removes module from the list of dependant modules
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DatasetModuleMeta

public DatasetModuleMeta(String name,
                 String className,
                 @Nullable
                 URI jarLocation,
                 List<String> types,
                 List<String> usesModules)

Creates instance of DatasetModuleMeta

Parameters:

name - name of the dataset module

className - class name of the dataset module

jarLocation - location of the dataset module jar. null means this is "system module" which classes always present in classpath. This helps to minimize redundant copying of jars.

types - list of types announced by this module in the order they are announced

usesModules - list of modules that this module depends on, ordered in a way they must be loaded and initialized

Method Detail

getName

public String getName()

Returns:

name of the dataset module

getClassName

public String getClassName()

Returns:

class name of the dataset module

getJarLocation

@Nullable
public URI getJarLocation()

Returns:

location of the dataset module jar, null means this is "system module" which classes always present in classpath. This helps to minimize redundant copying of jars

getTypes

public List<String> getTypes()

Returns:

list of types announced by this module in the order they are announced

getUsesModules

public List<String> getUsesModules()

Returns:

list of modules this module depends on, ordered in a way they must be loaded and initialized

getUsedByModules

public Collection<String> getUsedByModules()

Returns:

list of modules that depend on this module

addUsedByModule

public void addUsedByModule(String name)

Adds module to the list of dependant modules

Parameters:

name - name of the dependant module to add

removeUsedByModule

public void removeUsedByModule(String name)

Removes module from the list of dependant modules

Parameters:

name - name of the dependant module to remove

toString

public String toString()

Overrides:

toString in class Object