FsUriModifier (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

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

All Implemented Interfaces:: Serializable, Comparable<FsUriModifier>

@Immutable @DefaultAnnotation(value=edu.umd.cs.findbugs.annotations.NonNull.class) public enum FsUriModifier
extends Enum<FsUriModifier>
extends Enum<FsUriModifier>

Modifies a URI when parsing an FsPath, an FsMountPoint or an FsEntryName.

Author:: Christian Schlichtherle

Nested Class Summary
`static class`	`FsUriModifier.PostFix` Post-fixes a URI when it gets `canonicalized`.

Enum Constant Summary
`CANONICALIZE` The canonicalize modifier normalizes a URI and applies a `post-fix` which depends on the class to parse.
`NULL` The null modifier does nothing but ensure that the URI is normalized.

Method Summary
`(package private) abstract URI`	`modify(URI uri, FsUriModifier.PostFix fix)` An idempotent function which modifies a URI.
`static FsUriModifier`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static FsUriModifier[]`	`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

NULL

public static final FsUriModifier NULL

The null modifier does nothing but ensure that the URI is normalized.

CANONICALIZE

public static final FsUriModifier CANONICALIZE

The canonicalize modifier normalizes a URI and applies a post-fix which depends on the class to parse.

Method Detail

values

public static FsUriModifier[] 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 c : FsUriModifier.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 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,
                    FsUriModifier.PostFix fix)
             throws URISyntaxException

An idempotent function which modifies a URI.

Parameters:: uri - the URI to modify.; fix - the post-fix to apply if required.
Returns:: the modified URI.
Throws:: URISyntaxException