it.unimi.dsi.fastutil.chars.CharReferencePair Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of fastutil Show documentation
Show all versions of fastutil Show documentation
fastutil extends the Java Collections Framework by providing type-specific maps, sets, lists, and queues with a small memory footprint and fast access and insertion; it provides also big (64-bit) arrays, sets and lists, sorting algorithms, fast, practical I/O classes for binary and text files, and facilities for memory mapping large files. Note that if you have both this jar and fastutil-core.jar in your dependencies, fastutil-core.jar should be excluded.
/*
* Copyright (C) 2020-2023 Sebastiano Vigna
*
* 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 it.unimi.dsi.fastutil.chars;
/**
* A type-specific {@link it.unimi.dsi.fastutil.Pair Pair}; provides some additional methods that
* use polymorphism to avoid (un)boxing.
*/
public interface CharReferencePair extends it.unimi.dsi.fastutil.Pair {
/**
* Returns the left element of this pair.
*
* @return the left element of this pair.
*/
public char leftChar();
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public default Character left() {
return Character.valueOf(leftChar());
}
/**
* Sets the left element of this pair (optional operation).
*
* @param l a new value for the left element.
*
* @implSpec This implementation throws an {@link UnsupportedOperationException}.
*/
public default CharReferencePair left(final char l) {
throw new UnsupportedOperationException();
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public default CharReferencePair left(final Character l) {
return left((l).charValue());
}
/**
* Returns the left element of this pair.
*
* @return the left element of this pair.
*
* @implSpec This implementation delegates to {@link #left()}.
*
*/
public default char firstChar() {
return leftChar();
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public default Character first() {
return Character.valueOf(firstChar());
}
/**
* Sets the left element of this pair (optional operation).
*
* @param l a new value for the left element.
*
* @implSpec This implementation delegates to {@link #left(Object)}.
*/
public default CharReferencePair first(final char l) {
return left(l);
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public default CharReferencePair first(final Character l) {
return first((l).charValue());
}
/**
* Returns the left element of this pair.
*
* @return the left element of this pair.
*
* @implSpec This implementation delegates to {@link #left()}.
*
*/
public default char keyChar() {
return firstChar();
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public default Character key() {
return Character.valueOf(keyChar());
}
/**
* Sets the left element of this pair (optional operation).
*
* @param l a new value for the left element.
*
* @implSpec This implementation delegates to {@link #left(Object)}.
*/
public default CharReferencePair key(final char l) {
return left(l);
}
@Override
@Deprecated
public default CharReferencePair key(Character l) {
return key((l).charValue());
}
/**
* Returns a new type-specific immutable {@link it.unimi.dsi.fastutil.Pair Pair} with given left and
* right value.
*
* @param left the left value.
* @param right the right value.
*/
public static CharReferencePair of(final char left, final V right) {
return new CharReferenceImmutablePair(left, right);
}
}