Package org.infinispan.cli.resources

Class AbstractResource

java.lang.Object

org.infinispan.cli.resources.AbstractResource

All Implemented Interfaces:

Resource

Direct Known Subclasses:

CacheKeyResource, CacheResource, CachesResource, ClusterResource, ConfigurationsResource, ContainerResource, ContainersResource, CounterResource, CountersResource, NodeResource, RootResource, SchemasResource, ServerResource, TaskResource, TasksResource

public abstract class AbstractResource
extends Object
implements Resource

Since:

10.0

Author:

Tristan Tarrant <tristan@infinispan.org>

Nested Class Summary

Nested classes/interfaces inherited from interface org.infinispan.cli.resources.Resource

Resource.ListFormat

Field Summary

Fields inherited from interface org.infinispan.cli.resources.Resource

PARENT, THIS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractResource(Resource parent, String name)

Method Summary

Modifier and Type	Method	Description
String	describe()	Returns a textual representation of this resource
<T extends Resource> T	findAncestor(Class<T> resourceClass)	Finds the resource of the specified type within the ancestors of this resource
Resource	getChild(String name)	Returns a resource representing the named child
Resource	getChild(String... name)	Returns a resource representing the named child
Iterable<String>	getChildrenNames()	Returns an iterable over the children of this resource
String	getName()	Returns the name of this resource
Resource	getParent()	Returns the parent resource of this resource.
Resource	getResource(String path)
boolean	isLeaf()	Returns whether this resource is a leaf resource (i.e.
<T extends Resource> Optional<T>	optionalFindAncestor(Class<T> resourceClass)	Finds the resource of the specified type within the ancestors of this resource
void	printChildren(Resource.ListFormat format, int limit, PrettyPrinter.PrettyPrintMode prettyPrintMode, org.aesh.command.shell.Shell shell)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractResource

protected AbstractResource(Resource parent,
                           String name)

Method Detail

getName

public String getName()

Description copied from interface: Resource

Returns the name of this resource

Specified by:

getName in interface Resource

getParent

public Resource getParent()

Description copied from interface: Resource

Returns the parent resource of this resource. This is null if the resource represents the root.

Specified by:

getParent in interface Resource

getChildrenNames

public Iterable<String> getChildrenNames()
                                  throws IOException

Description copied from interface: Resource

Returns an iterable over the children of this resource

Specified by:

getChildrenNames in interface Resource

Throws:

IOException

printChildren

public void printChildren(Resource.ListFormat format,
                          int limit,
                          PrettyPrinter.PrettyPrintMode prettyPrintMode,
                          org.aesh.command.shell.Shell shell)
                   throws IOException

Specified by:

printChildren in interface Resource

Throws:

IOException

getChild

public Resource getChild(String name)
                  throws IOException

Description copied from interface: Resource

Returns a resource representing the named child

Specified by:

getChild in interface Resource

Throws:

IOException

getChild

public Resource getChild(String... name)
                  throws IOException

Description copied from interface: Resource

Returns a resource representing the named child

Specified by:

getChild in interface Resource

Throws:

IOException

findAncestor

public <T extends Resource> T findAncestor(Class<T> resourceClass)

Description copied from interface: Resource

Finds the resource of the specified type within the ancestors of this resource

Specified by:

findAncestor in interface Resource

optionalFindAncestor

public <T extends Resource> Optional<T> optionalFindAncestor(Class<T> resourceClass)

Description copied from interface: Resource

Finds the resource of the specified type within the ancestors of this resource

Specified by:

optionalFindAncestor in interface Resource

isLeaf

public boolean isLeaf()

Description copied from interface: Resource

Returns whether this resource is a leaf resource (i.e. it has no children, or the children are not navigable)

Specified by:

isLeaf in interface Resource

describe

public String describe()
                throws IOException

Description copied from interface: Resource

Returns a textual representation of this resource

Specified by:

describe in interface Resource

Throws:

IOException

getResource

public Resource getResource(String path)
                     throws IOException

Specified by:

getResource in interface Resource

Throws:

IOException