Package org.apache.commons.io

Enum FileSystem.NameLengthStrategy

java.lang.Object

java.lang.Enum<FileSystem.NameLengthStrategy>

org.apache.commons.io.FileSystem.NameLengthStrategy

All Implemented Interfaces:

Serializable, Comparable<FileSystem.NameLengthStrategy>

Enclosing class:

FileSystem

static enum FileSystem.NameLengthStrategy
extends Enum<FileSystem.NameLengthStrategy>

Strategy for measuring and truncating file or path names in different units. Implementations measure length and can truncate to a specified limit.

Enum Constant Summary

Enum Constants

Enum Constant	Description
BYTES	Length measured as encoded bytes.
UTF16_CODE_UNITS	Length measured as UTF-16 code units (i.e., CharSequence.length()).

Constructor Summary

Constructors

Modifier	Constructor	Description
private	NameLengthStrategy()

Method Summary

Modifier and Type	Method	Description
(package private) abstract int	getLength(CharSequence value, Charset charset)	Gets the measured length in this strategy’s unit.
(package private) final boolean	isWithinLimit(CharSequence value, int limit, Charset charset)	Tests if the measured length is less or equal the limit.
(package private) abstract CharSequence	truncate(CharSequence value, int limit, Charset charset)	Truncates to limit in this strategy’s unit (no-op if already within limit).
static FileSystem.NameLengthStrategy	valueOf(String name)	Returns the enum constant of this type with the specified name.
static FileSystem.NameLengthStrategy[]	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 Details

BYTES

public static final FileSystem.NameLengthStrategy BYTES

Length measured as encoded bytes.

UTF16_CODE_UNITS

public static final FileSystem.NameLengthStrategy UTF16_CODE_UNITS

Length measured as UTF-16 code units (i.e., CharSequence.length()).

Constructor Details

NameLengthStrategy

private NameLengthStrategy()

Method Details

values

public static FileSystem.NameLengthStrategy[] values()

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

Returns:

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

valueOf

public static FileSystem.NameLengthStrategy 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

getLength

abstract int getLength(CharSequence value,
 Charset charset)

Gets the measured length in this strategy’s unit.

Parameters:

value - The value to measure, not null.

charset - The charset to use when measuring in bytes.

Returns:

The length in this strategy’s unit.

isWithinLimit

final boolean isWithinLimit(CharSequence value,
 int limit,
 Charset charset)

Tests if the measured length is less or equal the limit.

Parameters:

value - The value to measure, not null.

limit - The limit to compare to.

charset - The charset to use when measuring in bytes.

Returns:

true if the measured length is less or equal the limit, false otherwise.

truncate

abstract CharSequence truncate(CharSequence value,
 int limit,
 Charset charset)

Truncates to limit in this strategy’s unit (no-op if already within limit).

Parameters:

value - The value to truncate, not null.

limit - The limit to truncate to.

charset - The charset to use when measuring in bytes.

Returns:

The truncated value, not null.