FsUriModifier.PostFix (TrueZIP Kernel 7.0-rc2 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

TrueZIP Kernel 7.0-rc2

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD

DETAIL: ENUM CONSTANTS | FIELD | METHOD

de.schlichtherle.truezip.fs
Enum FsUriModifier.PostFix

java.lang.Object
  java.lang.Enum<FsUriModifier.PostFix>
      de.schlichtherle.truezip.fs.FsUriModifier.PostFix

All Implemented Interfaces:: Serializable, Comparable<FsUriModifier.PostFix>

Enclosing class:: FsUriModifier

@Immutable public static enum FsUriModifier.PostFix
extends Enum<FsUriModifier.PostFix>
extends Enum<FsUriModifier.PostFix>

Post-fixes a URI when it gets canonicalized.

Enum Constant Summary
`ENTRY_NAME` The post-fix for an `FsEntryName` depends on the URI type: For an opaque URI, nothing is modified.
`MOUNT_POINT` The post-fix for an `FsMountPoint` does nothing.
`PATH` The post-fix for an `FsPath` depends on the URI type: For an opaque URI, nothing is modified.

Method Summary
`(package private) abstract URI`	`modify(URI uri)` An idempotent function which modifies a URI.
`static FsUriModifier.PostFix`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static FsUriModifier.PostFix[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
`clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf`

Methods inherited from class java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`

Enum Constant Detail

PATH

public static final FsUriModifier.PostFix PATH

The post-fix for an FsPath depends on the URI type: For an opaque URI, nothing is modified. For a hierarchical URI, its path is truncated so that it does not end with a "/" separator. In addition, if the path starts with two separators, the substring following until the next separator is moved to the authority part of the URI. This behavior is intended to fix URIs returned by File.toURI().

MOUNT_POINT

public static final FsUriModifier.PostFix MOUNT_POINT

The post-fix for an FsMountPoint does nothing.

ENTRY_NAME

public static final FsUriModifier.PostFix ENTRY_NAME

The post-fix for an FsEntryName depends on the URI type: For an opaque URI, nothing is modified. For a hierarchical URI, its path is truncated so that it does not end with a "/" separator.

Method Detail

values

public static FsUriModifier.PostFix[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FsUriModifier.PostFix c : FsUriModifier.PostFix.values())
    System.out.println(c);

Returns:: an array containing the constants of this enum type, in the order they are declared

valueOf

public static FsUriModifier.PostFix valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:: name - the name of the enum constant to be returned.
Returns:: the enum constant with the specified name
Throws:: IllegalArgumentException - if this enum type has no constant with the specified name; NullPointerException - if the argument is null

modify

abstract URI modify(URI uri)
             throws URISyntaxException

An idempotent function which modifies a URI.

Parameters:: uri - the URI to modify.
Returns:: the modified URI.
Throws:: URISyntaxException