org.jboss.forge.resources.java
Class JavaFieldResource

java.lang.Object
  org.jboss.forge.resources.AbstractResource<T>
      org.jboss.forge.resources.VirtualResource<T>
          org.jboss.forge.resources.java.JavaMemberResource<Field<JavaSource<?>>>
              org.jboss.forge.resources.java.JavaFieldResource

All Implemented Interfaces:

Resource<Field<JavaSource<?>>>

public class JavaFieldResource
extends JavaMemberResource<Field<JavaSource<?>>>

Author:

Lincoln Baxter, III

Field Summary

Fields inherited from class org.jboss.forge.resources.AbstractResource

flags, parent, resourceFactory

Constructor Summary

JavaFieldResource(JavaResource parent, Field<JavaSource<?>> field)

Method Summary

Resource<Field<JavaSource<?>>>	createFrom(Field<JavaSource<?>> 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.
String	getName() Return the common name of the resource.
Field<JavaSource<?>>	getUnderlyingResourceObject() Get the underlying object represented by this Resource
List<Resource<?>>	listResources() Return a list of child resources of the current 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, reify, setFlag, unsetFlag

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaFieldResource

public JavaFieldResource(JavaResource parent,
                         Field<JavaSource<?>> field)

Method Detail

createFrom

public Resource<Field<JavaSource<?>>> createFrom(Field<JavaSource<?>> 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<Field<JavaSource<?>>>

Overrides:

createFrom in class JavaMemberResource<Field<JavaSource<?>>>

Parameters:

file - The target reference to create the resource instance from.

Returns:

A new resource.

listResources

public List<Resource<?>> listResources()

Description copied from interface: Resource

Return a list of child resources of the current resource.

Specified by:

listResources in interface Resource<Field<JavaSource<?>>>

Overrides:

listResources in class JavaMemberResource<Field<JavaSource<?>>>

getUnderlyingResourceObject

public Field<JavaSource<?>> getUnderlyingResourceObject()

Description copied from interface: Resource

Get the underlying object represented by this Resource

Specified by:

getUnderlyingResourceObject in interface Resource<Field<JavaSource<?>>>

Overrides:

getUnderlyingResourceObject in class JavaMemberResource<Field<JavaSource<?>>>

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.

Specified by:

getName in interface Resource<Field<JavaSource<?>>>

Overrides:

getName in class JavaMemberResource<Field<JavaSource<?>>>

Returns:

The name of the resource.

toString

public String toString()

Overrides:

toString in class JavaMemberResource<Field<JavaSource<?>>>

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.