de.ipcon.tools

Class L10nPathEntry

java.lang.Object

de.ipcon.tools.L10nPathEntry

All Implemented Interfaces:

SecureExternalizable, java.io.Externalizable, java.io.Serializable, java.lang.Comparable

public class L10nPathEntry
extends java.lang.Object
implements SecureExternalizable, java.lang.Comparable, java.io.Externalizable

Represents a single entry within a localization (L10n) lookup path.

Each entry defines a specific location or context where localization resources might be found. Instances of this class are designed to be sorted and uniquely identified based on their position and path.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static L10nPathEntry[]	EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
L10nPathEntry() Constructs a new, empty L10nPathEntry instance.
L10nPathEntry(java.lang.String _path, int _position) Constructs a new L10nPathEntry with the specified path and position.

Method Summary

Modifier and Type	Method and Description
int	compareTo(java.lang.Object other) Compares this L10nPathEntry with the specified object for order.
java.lang.String	getPath() Returns the path string of this localization path entry.
int	getPosition() Returns the position of this localization path entry in the lookup order.
void	readExternal(java.io.ObjectInput in) Reads the state of this L10nPathEntry instance from an ObjectInput stream.
void	readInstance(SecureObjectInputI in) Reads the state of this L10nPathEntry instance from a SecureObjectInputI stream.
void	writeExternal(java.io.ObjectOutput out) Writes the state of this L10nPathEntry instance to an ObjectOutput stream.
void	writeInstance(SecureObjectOutputI out) Writes the state of this L10nPathEntry instance to a SecureObjectOutputI stream.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EMPTY_ARRAY

public static final L10nPathEntry[] EMPTY_ARRAY

Constructor Detail

L10nPathEntry

public L10nPathEntry(java.lang.String _path,
                     int _position)

Constructs a new L10nPathEntry with the specified path and position.

Parameters:

path - The path String for this localization path entry. Must not be null.

position - The integer position of this entry in the localization lookup order.

Throws:

java.lang.IllegalArgumentException - If the provided path is null.

L10nPathEntry

public L10nPathEntry()

Constructs a new, empty L10nPathEntry instance.

This no-argument constructor is specifically provided to facilitate instantiation when objects of this class are read via the SecureExternalizable interface. It is typically invoked by the deserialization mechanism and should not be used for normal object creation, as the fields will not be initialized until java.io.SecureExternalizable#readInstance(java.io.ObjectInput) is called.

Method Detail

getPath

public java.lang.String getPath()

Returns the path string of this localization path entry.

Returns:

The path as a String.

getPosition

public int getPosition()

Returns the position of this localization path entry in the lookup order.

Returns:

The position as an integer.

compareTo

public int compareTo(java.lang.Object other)

Compares this L10nPathEntry with the specified object for order.

The natural sorting order for L10nPathEntry instances is defined as follows:

1. Ascending by position: Entries are primarily sorted based on their numerical position.
2. Alphabetical by path: If two entries have the same position, they are then sorted alphabetically (case-sensitively) based on their path string.

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

other - The object to be compared. It is expected to be an instance of L10nPathEntry.

Returns:

A negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Throws:

java.lang.ClassCastException - if the specified object's type prevents it from being compared to this object.

writeInstance

public void writeInstance(SecureObjectOutputI out)
                   throws java.io.IOException

Writes the state of this L10nPathEntry instance to a SecureObjectOutputI stream. This method is part of the SecureExternalizable contract.

Specified by:

writeInstance in interface SecureExternalizable

Parameters:

out - The SecureObjectOutputI stream to which the object's state will be written.

Throws:

IOException - If an I/O error occurs during writing.

readInstance

public void readInstance(SecureObjectInputI in)
                  throws java.io.IOException

Reads the state of this L10nPathEntry instance from a SecureObjectInputI stream. This method is part of the SecureExternalizable contract and is responsible for reconstructing the object's fields from the stream.

Specified by:

readInstance in interface SecureExternalizable

Parameters:

in - The SecureObjectInputI stream from which the object's state will be read.

Throws:

IOException - If an I/O error occurs during reading.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Writes the state of this L10nPathEntry instance to an ObjectOutput stream. This method is part of the Externalizable contract. It writes the path as a UTF string and the position as an integer.

Specified by:

writeExternal in interface java.io.Externalizable

Parameters:

out - The ObjectOutput stream to which the object's state will be written.

Throws:

IOException - If an I/O error occurs during writing.

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException

Reads the state of this L10nPathEntry instance from an ObjectInput stream. This method is part of the Externalizable contract and is responsible for reconstructing the object's fields from the stream. It reads the path as a UTF string and the position as an integer.

Specified by:

readExternal in interface java.io.Externalizable

Parameters:

in - The ObjectInput stream from which the object's state will be read.

Throws:

IOException - If an I/O error occurs during reading.