org.nuxeo.core.resources.model.impl
Class SiteFolder

java.lang.Object
  extended by org.eclipse.core.runtime.PlatformObject
      extended by org.nuxeo.core.resources.model.impl.SiteResource
          extended by org.nuxeo.core.resources.model.impl.SiteFolder
All Implemented Interfaces:
org.eclipse.core.runtime.IAdaptable, IContainer, ISiteFolder, ISiteResource
Direct Known Subclasses:
Site

public class SiteFolder
extends SiteResource
implements ISiteFolder

Author:
Bogdan Stefanescu

Field Summary
 
Fields inherited from interface org.nuxeo.core.resources.model.ISiteResource
FILE, FOLDER, SITE
 
Fields inherited from interface org.nuxeo.core.resources.model.IContainer
EMPTY_CHILDREN
 
Constructor Summary
SiteFolder(ISite site, java.lang.String path)
           
 
Method Summary
 boolean accept(ISiteResourceVisitor visitor, java.lang.Object context)
          Accept a visitor on this node of the resource tree
 ISiteResource[] children(org.eclipse.core.runtime.IProgressMonitor monitor)
          Get an array with existing children in this container
 ISiteResource findChild(java.lang.String path)
          Find the child given its relative path to this container The returned child is existing
 ISiteFile getFile(java.lang.String path)
          Get a file resource (of type FILE) for the given relative path (relative to the container) This is a handle operation thus it is allways returning a not null handle even if the resource is not existing
 ISiteFolder getFolder(java.lang.String path)
          Get a file resource (of type FILE) for the given relative path (relative to the container) This is a handle operation thus it is allways returning a not null handle even if the resource is not existing
 int getType()
          Get the resource type.
 
Methods inherited from class org.nuxeo.core.resources.model.impl.SiteResource
create, delete, edit, exists, getContents, getController, getMetadata, getName, getParent, getPath, getSite, getURI, modify
 
Methods inherited from class org.eclipse.core.runtime.PlatformObject
getAdapter
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.nuxeo.core.resources.model.ISiteResource
create, delete, edit, exists, getContents, getMetadata, getName, getParent, getPath, getSite, getURI, modify
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 

Constructor Detail

SiteFolder

public SiteFolder(ISite site,
                  java.lang.String path)
Method Detail

getType

public int getType()
Description copied from interface: ISiteResource
Get the resource type.

Specified by:
getType in interface ISiteResource
Specified by:
getType in class SiteResource
Returns:
the resource type

accept

public boolean accept(ISiteResourceVisitor visitor,
                      java.lang.Object context)
Description copied from interface: ISiteResource
Accept a visitor on this node of the resource tree

Specified by:
accept in interface ISiteResource
Specified by:
accept in class SiteResource
Parameters:
visitor - the visitor
context - a context object to be used by the visitor or null
Returns:
true if the traversal must continue otherwise false

findChild

public ISiteResource findChild(java.lang.String path)
                        throws org.eclipse.core.runtime.CoreException
Description copied from interface: IContainer
Find the child given its relative path to this container The returned child is existing

Specified by:
findChild in interface IContainer
Parameters:
path - the relative path
Returns:
the child if found otherwise null
Throws:
org.eclipse.core.runtime.CoreException

children

public ISiteResource[] children(org.eclipse.core.runtime.IProgressMonitor monitor)
                         throws org.eclipse.core.runtime.CoreException
Description copied from interface: IContainer
Get an array with existing children in this container

Specified by:
children in interface IContainer
Parameters:
monitor - the progress monitor to use or null if not required
Returns:
an array with existing child resources or an empty array if no children are found
Throws:
org.eclipse.core.runtime.CoreException

getFile

public ISiteFile getFile(java.lang.String path)
Description copied from interface: ISiteFolder
Get a file resource (of type FILE) for the given relative path (relative to the container) This is a handle operation thus it is allways returning a not null handle even if the resource is not existing

Specified by:
getFile in interface ISiteFolder
Parameters:
path - the path for the file to return
Returns:
the file at the given path. Cannot never null even if the file is not existing

getFolder

public ISiteFolder getFolder(java.lang.String path)
Description copied from interface: ISiteFolder
Get a file resource (of type FILE) for the given relative path (relative to the container) This is a handle operation thus it is allways returning a not null handle even if the resource is not existing

Specified by:
getFolder in interface ISiteFolder
Parameters:
path - the path for the folder to return
Returns:
the folder at the given path. Cannot never null even if the folder is not existing