com.hpe.caf.naming.Name Maven / Gradle / Ivy
The newest version!
/*
* Copyright 2015-2024 Open Text.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.hpe.caf.naming;
import java.util.Arrays;
import java.util.Iterator;
import java.util.List;
import java.util.Objects;
import java.util.regex.Pattern;
/**
* A class that is similar to java.naming.Name, but is iterable. A Name is a tokenized character String, delimited by forward-slashes.
*/
public class Name implements Iterable
{
private final List components;
private final String strRepresentation;
/**
* Create a new Name. Leading and trailing forward-slashes are allowed.
*
* @param name the String to create the name from
*/
public Name(final String name)
{
String fixedName = name.replaceAll("^/+|/+$", "");
components = Arrays.asList(fixedName.split(Pattern.quote("/")));
strRepresentation = String.join("/", components);
}
/**
* Createa a new Name from a list of tokens.
*
* @param components the parts that will make up the Name, already tokenized into a List
*/
public Name(final List components)
{
this.components = components;
strRepresentation = String.join("/", components);
}
/**
* @return the number of tokenized components of this Name
*/
public int size()
{
return components.size();
}
/**
* Get the components of the Name at the specified numeric index
*
* @param index the index of the token to return, starting from 0
* @return the requested Name component
* @throws IllegalArgumentException if you request an index that does not exist
*/
public String getIndex(final int index)
{
if (index < 0 || index >= components.size()) {
throw new IllegalArgumentException("Index out of bounds");
}
return components.get(index);
}
/**
* Return a Name that consists of a subsection of the current Name.
*
* @param upperIndex the upper index (exclusive) of components to build the Name from
* @return a new Name, that is a sub-set of the current Name
* @throws IllegalArgumentException if you request an index that is no in the range of components of this Name
*/
public Name getPrefix(final int upperIndex)
{
if (upperIndex < 0 || upperIndex > components.size()) {
throw new IllegalArgumentException("Index out of bounds");
}
return new Name(components.subList(0, upperIndex));
}
@Override
public String toString()
{
return strRepresentation;
}
@Override
public Iterator iterator()
{
return components.iterator();
}
@Override
public boolean equals(final Object o)
{
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
Name strings = (Name) o;
return Objects.equals(components, strings.components);
}
@Override
public int hashCode()
{
return Objects.hash(components);
}
}