com.wavemaker.commons.io.Folder Maven / Gradle / Ivy
/**
* Copyright (C) 2020 WaveMaker, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.wavemaker.commons.io;
import com.wavemaker.commons.io.exception.ResourceTypeMismatchException;
/**
* A folder {@link Resource} that may be stored on a physical disk or using some other mechanism.
*
* @see File
*
* @author Phillip Webb
*/
public interface Folder extends Resource, Iterable {
@Override
Folder moveTo(Folder folder);
/**
* Convenience methods to move the contents of the folder. Equivalent to {@link #list()}.
* {@link Resources#moveTo(Folder) moveTo(folder)}.
*
* @param folder the folder to move the resource to
* @return a resource collection containing the new destination resources
* @see Resources#moveTo(Folder)
*/
Resources moveContentsTo(Folder folder);
@Override
Folder copyTo(Folder folder);
/**
* Convenience methods to move the contents of the folder. Equivalent to {@link #list()}.
* {@link Resources#copyTo(Folder) copyTo(folder)}.
*
* @param folder the folder to copy the resource to
* @return a resource collection containing the new destination resources
* @see Resources#copyTo(Folder)
*/
Resources copyContentsTo(Folder folder);
@Override
Folder rename(String name);
/**
* Return a child from the current folder that refers to an existing {@link File} or {@link Folder}. If the
* name includes '/' characters then the file will be returned from nested folders. Paths are relative
* unless they begin with '/', in which case they are taken from the topmost {@link #getParent() parent}. Use '..'
* to refer to a parent folder.
*
* @param name the name of the resource
* @return a {@link File} or {@link Folder} resource
* @throws com.wavemaker.commons.io.exception.ResourceDoesNotExistException if the resource does not exist
* @see #hasExisting(String)
*/
Resource getExisting(String name);
/**
* Returns true if this folder already contains a resource with the specified name. This method supports
* the same naming rules as {@link #getExisting(String)}.
*
* @param name the name of the resource
* @return true if the resource is contained in the folder
* @see #getExisting(String)
*/
boolean hasExisting(String name);
/**
* Get a child folder of the current folder. This method supports the same naming rules as
* {@link #getExisting(String)}.
*
* @param name the name of the folder to get
* @return the {@link Folder}
* @throws com.wavemaker.commons.io.exception.ResourceTypeMismatchException if the an existing resource exits that is not a folder
*/
Folder getFolder(String name);
/**
* Get a child file of the current folder. This method supports the same naming rules as
* {@link #getExisting(String)}.
*
* @param name the name of the file to get
* @return the {@link File}
* @throws ResourceTypeMismatchException if the an existing resource exits that is not a file
*/
File getFile(String name);
/**
* Get a child file or folder of the current folder. Depending on the resourceType {@link #getFile(String)}
* , {@link #getFolder(String)} or {@link #getExisting(String)} will be called. This method supports the same naming
* rules as {@link #getExisting(String)}.
*
* @param name the name of the resource to get
* @param resourceType the resource type
* @return the resource.
* @throws ResourceTypeMismatchException if the an existing resource exits that is of the wrong type
*/
T get(String name, Class resourceType);
/**
* List all immediate child resources of this folder. If this resource does not exist empty resources are returned.
*
* @return a list of all immediate child resources
*/
Resources list();
/**
* Recursively find all immediate and nested children of this folder. If this resource does not exist empty
* resources are returned.
*
* @return a list of all nested children
*/
Resources find();
/**
* Return a new folder that is jailed at the current location. A jailed folder acts as a root folder at the current
* location.
*
* @return a new jailed folder
*/
Folder jail();
}