PathMgr

Introduction

This article describes the KOS PathMgr component.

API Components

This section defines the PathMgr component.

PathMgr (component)

API: PathMgr class

public class PathMgr {

    // Name of the root path:
    public static final String ROOT = "root";

    public NamedPath addPath(String  name, NamedPath base, String path);
    public NamedPath addPath(Enum<?> name, NamedPath base, String path);

    public NamedPath addPath(String  name, String  baseName, String path);
    public NamedPath addPath(Enum<?> name, String  baseName, String path);
    public NamedPath addPath(Enum<?> name, Enum<?> baseName, String path);

    public NamedPath getPath(String  name);
    public NamedPath getPath(Enum<?> name);

    public File getFile(String  name);
    public File getFile(Enum<?> name);

    public File getFile(String  name, String path);
    public File getFile(Enum<?> name, String path);

    public void mkdirs(String  name);
    public void mkdirs(Enum<?> name);
}

NamedPath (class)

API: NamedPath class

public class NamedPath {

    @Getter
    private String name;

    public String getPath();
    public String getPath(String path);

    public File getFile();
    public File getFile(String path);
}

NamedPathOverrides (interface)

API: NamedPathOverrides interface

public interface NamedPathOverrides {

    // Returns an override path for the specified name, or null if there is no override:
    String getOverride(String name);
}

[prev]

[next]

On this page