Forge - Shell API 1.2.0.Final

org.jboss.forge.resources.enumtype
Class EnumConstantResource

java.lang.Object
  extended by org.jboss.forge.resources.AbstractResource<T>
      extended by org.jboss.forge.resources.VirtualResource<EnumConstant<JavaEnum>>
          extended by org.jboss.forge.resources.enumtype.EnumConstantResource
All Implemented Interfaces:
Resource<EnumConstant<JavaEnum>>

public class EnumConstantResource
extends VirtualResource<EnumConstant<JavaEnum>>


Field Summary
 
Fields inherited from class org.jboss.forge.resources.AbstractResource
flags, parent, resourceFactory
 
Constructor Summary
EnumConstantResource(Resource<?> parent, EnumConstant<JavaEnum> enumConstant)
           
 
Method Summary
 Resource<EnumConstant<JavaEnum>> createFrom(EnumConstant<JavaEnum> file)
          Create a new resource instance for the target resource reference of the type that this current resource is.
 boolean delete()
          Delete this resource, return true if successful, false if not.
 boolean delete(boolean recursive)
          Delete this resource, return true if successful, false if not.
protected  List<Resource<?>> doListResources()
          Strategy method for returning child resources.
 String getName()
          Return the common name of the resource.
 EnumConstant<JavaEnum> getUnderlyingResourceObject()
          Get the underlying object represented by this Resource
 String toString()
           
 
Methods inherited from class org.jboss.forge.resources.VirtualResource
exists, getChild, getResourceInputStream
 
Methods inherited from class org.jboss.forge.resources.AbstractResource
equals, getFlags, getFullyQualifiedName, getParent, getResourceFactory, hashCode, isFlagSet, listResources, listResources, reify, setFlag, unsetFlag
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

EnumConstantResource

public EnumConstantResource(Resource<?> parent,
                            EnumConstant<JavaEnum> enumConstant)
Method Detail

createFrom

public Resource<EnumConstant<JavaEnum>> createFrom(EnumConstant<JavaEnum> file)
Description copied from interface: Resource
Create a new resource instance for the target resource reference of the type that this current resource is.

Specified by:
createFrom in interface Resource<EnumConstant<JavaEnum>>
Overrides:
createFrom in class VirtualResource<EnumConstant<JavaEnum>>
Parameters:
file - The target reference to create the resource instance from.
Returns:
A new resource.

doListResources

protected List<Resource<?>> doListResources()
Description copied from class: AbstractResource
Strategy method for returning child resources. Subclasses should implement or override this method.

Specified by:
doListResources in class AbstractResource<EnumConstant<JavaEnum>>
Returns:

getUnderlyingResourceObject

public EnumConstant<JavaEnum> getUnderlyingResourceObject()
Description copied from interface: Resource
Get the underlying object represented by this Resource


getName

public String getName()
Description copied from interface: Resource
Return the common name of the resource. If it's a file, for instance, just the file name.

Returns:
The name of the resource.

toString

public String toString()
Overrides:
toString in class Object

delete

public boolean delete()
               throws UnsupportedOperationException
Description copied from interface: Resource
Delete this resource, return true if successful, false if not.

Throws:
UnsupportedOperationException - if deleting is not supported by the underlying implementation.

delete

public boolean delete(boolean recursive)
               throws UnsupportedOperationException
Description copied from interface: Resource
Delete this resource, return true if successful, false if not.

Parameters:
recursive - if false and this resource both supports recursive deletion and contains children, deletion will not occur; otherwise, if true, deletion will propagate to all child resources. Implementations may choose simply to delegate to Resource.delete()
Throws:
UnsupportedOperationException - if deleting is not supported by the underlying implementation.

Forge - Shell API 1.2.0.Final

Copyright © 2013 JBoss by Red Hat. All Rights Reserved.