*/
package org.opendaylight.yangtools.yang.common;
-import static com.google.common.base.Preconditions.checkArgument;
+import static java.util.Objects.requireNonNull;
import com.google.common.annotations.Beta;
-import com.google.common.cache.CacheBuilder;
-import com.google.common.cache.CacheLoader;
-import com.google.common.cache.LoadingCache;
-import org.opendaylight.yangtools.concepts.Immutable;
+import com.google.common.collect.Interner;
+import com.google.common.collect.Interners;
+import org.eclipse.jdt.annotation.NonNull;
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.eclipse.jdt.annotation.Nullable;
+import org.opendaylight.yangtools.concepts.Variant;
/**
* Dedicated type for YANG's 'type uint16' type.
* @author Robert Varga
*/
@Beta
-public class Uint16 extends Number implements Comparable<Uint16>, Immutable {
+@NonNullByDefault
+public class Uint16 extends Number implements CanonicalValue<Uint16> {
+ public static final class Support extends AbstractCanonicalValueSupport<Uint16> {
+ public Support() {
+ super(Uint16.class);
+ }
+
+ @Override
+ public Variant<Uint16, CanonicalValueViolation> fromString(final String str) {
+ try {
+ return Variant.ofFirst(Uint16.valueOf(str));
+ } catch (IllegalArgumentException e) {
+ return CanonicalValueViolation.variantOf(e);
+ }
+ }
+ }
+
+ private static final CanonicalValueSupport<Uint16> SUPPORT = new Support();
private static final long serialVersionUID = 1L;
- private static final int MIN_VALUE = 0;
- private static final int MAX_VALUE = 65535;
+ private static final int MAX_VALUE_INT = 65535;
+ private static final String MAX_VALUE_STR = "65535";
- /**
- * Cache of first 256 values.
- */
- private static final Uint16[] CACHE = new Uint16[Uint8.MAX_VALUE];
+ private static final String CACHE_SIZE_PROPERTY = "org.opendaylight.yangtools.yang.common.Uint16.cache.size";
+ private static final int DEFAULT_CACHE_SIZE = 256;
/**
- * Commonly encountered values.
+ * Tunable cache for values. By default it holds {@value #DEFAULT_CACHE_SIZE} entries. This can be
+ * changed via {@value #CACHE_SIZE_PROPERTY} system property.
*/
- private static final Uint16[] COMMON = new Uint16[] {
- new Uint16(Short.MAX_VALUE),
- new Uint16((short)32768),
- new Uint16((short)65535),
- };
+ private static final int CACHE_SIZE;
- /**
- * Tunable weak LRU cache for other values. By default it holds {@value #DEFAULT_LRU_SIZE} entries. This can be
- * changed via {@value #LRU_SIZE_PROPERTY} system property.
- */
- private static final int DEFAULT_LRU_SIZE = 1024;
- private static final String LRU_SIZE_PROPERTY = "org.opendaylight.yangtools.yang.common.Uint16.LRU.size";
- private static final int MAX_LRU_SIZE = MAX_VALUE + 1;
- private static final int LRU_SIZE;
+ static {
+ final int p = Integer.getInteger(CACHE_SIZE_PROPERTY, DEFAULT_CACHE_SIZE);
+ CACHE_SIZE = p >= 0 ? Math.min(p, MAX_VALUE_INT + 1) : DEFAULT_CACHE_SIZE;
+ }
+
+ private static final @NonNull Uint16[] CACHE;
static {
- final int p = Integer.getInteger(LRU_SIZE_PROPERTY, DEFAULT_LRU_SIZE);
- LRU_SIZE = p >= 0 ? Math.min(p, MAX_LRU_SIZE) : DEFAULT_LRU_SIZE;
+ final Uint16[] c = new Uint16[CACHE_SIZE];
+ for (int i = 0; i < c.length; ++i) {
+ c[i] = new Uint16((short) i);
+ }
+ CACHE = c;
}
- private static final LoadingCache<Short, Uint16> LRU = CacheBuilder.newBuilder().weakValues().maximumSize(LRU_SIZE)
- .build(new CacheLoader<Short, Uint16>() {
- @Override
- public Uint16 load(final Short key) {
- return new Uint16(key);
- }
- });
+ private static final Interner<Uint16> INTERNER = Interners.newWeakInterner();
+
+ public static final Uint16 ZERO = valueOf(0).intern();
+ public static final Uint16 ONE = valueOf(1).intern();
+ public static final Uint16 MAX_VALUE = valueOf(MAX_VALUE_INT).intern();
private final short value;
- Uint16(final short value) {
+ private Uint16(final short value) {
this.value = value;
}
protected Uint16(final Uint16 other) {
- this.value = other.value;
+ this(other.value);
}
private static Uint16 instanceFor(final short value) {
final int slot = Short.toUnsignedInt(value);
- if (slot >= CACHE.length) {
- for (Uint16 c : COMMON) {
- if (c.value == value) {
- return c;
- }
- }
-
- return LRU.getUnchecked(value);
- }
-
- Uint16 ret = CACHE[slot];
- if (ret == null) {
- synchronized (CACHE) {
- ret = CACHE[slot];
- if (ret == null) {
- ret = new Uint16(value);
- CACHE[slot] = ret;
- }
- }
- }
-
- return ret;
+ return slot < CACHE.length ? CACHE[slot] : new Uint16(value);
}
+ /**
+ * Returns an {@code Uint16} corresponding to a given bit representation. The argument is interpreted as an
+ * unsigned 16-bit value.
+ *
+ * @param bits unsigned bit representation
+ * @return A Uint16 instance
+ */
public static Uint16 fromShortBits(final short bits) {
return instanceFor(bits);
}
+ /**
+ * Returns an {@code Uint16} corresponding to a given {@code byteVal}. The inverse operation is
+ * {@link #byteValue()}.
+ *
+ * @param byteVal byte value
+ * @return A Uint16 instance
+ * @throws IllegalArgumentException if byteVal is less than zero
+ */
public static Uint16 valueOf(final byte byteVal) {
- checkArgument(byteVal >= MIN_VALUE, "Negative values are not allowed");
+ UintConversions.checkNonNegative(byteVal, MAX_VALUE_STR);
return instanceFor(byteVal);
}
+ /**
+ * Returns an {@code Uint16} corresponding to a given {@code shortVal}. The inverse operation is
+ * {@link #shortValue()}.
+ *
+ * @param shortVal short value
+ * @return A Uint16 instance
+ * @throws IllegalArgumentException if shortVal is less than zero.
+ */
public static Uint16 valueOf(final short shortVal) {
- checkArgument(shortVal >= MIN_VALUE, "Negative values are not allowed");
+ UintConversions.checkNonNegative(shortVal, MAX_VALUE_STR);
return instanceFor(shortVal);
}
+ /**
+ * Returns an {@code Uint16} corresponding to a given {@code intVal}. The inverse operation is {@link #intValue()}.
+ *
+ * @param intVal int value
+ * @return A Uint16 instance
+ * @throws IllegalArgumentException if intVal is less than zero or greater than 65535.
+ */
public static Uint16 valueOf(final int intVal) {
- checkArgument(intVal >= MIN_VALUE && intVal <= MAX_VALUE, "Value %s is outside of allowed range", intVal);
- return instanceFor((short)(intVal & 0xffff));
+ UintConversions.checkRange(intVal, MAX_VALUE_INT);
+ return instanceFor((short)intVal);
}
+ /**
+ * Returns an {@code Uint16} corresponding to a given {@code longVal}. The inverse operation is
+ * {@link #longValue()}.
+ *
+ * @param longVal long value
+ * @return A Uint16 instance
+ * @throws IllegalArgumentException if intVal is less than zero or greater than 65535.
+ */
public static Uint16 valueOf(final long longVal) {
- checkArgument(longVal >= MIN_VALUE && longVal <= MAX_VALUE, "Value %s is outside of allowed range", longVal);
- return instanceFor((short)(longVal & 0xffff));
+ UintConversions.checkRange(longVal, MAX_VALUE_INT);
+ return instanceFor((short)longVal);
}
+ /**
+ * Returns an {@code Uint16} corresponding to a given {@code uint}.
+ *
+ * @param uint Uint8 value
+ * @return A Uint16 instance
+ * @throws NullPointerException if uint is null
+ */
public static Uint16 valueOf(final Uint8 uint) {
return instanceFor(uint.shortValue());
}
+ /**
+ * Returns an {@code Uint8} corresponding to a given {@code uint}.
+ *
+ * @param uint Uint32 value
+ * @return A Uint16 instance
+ * @throws NullPointerException if uint is null
+ * @throws IllegalArgumentException if uint is greater than 65535.
+ */
public static Uint16 valueOf(final Uint32 uint) {
return valueOf(uint.longValue());
}
+ /**
+ * Returns an {@code Uint8} corresponding to a given {@code uint}.
+ *
+ * @param uint Uint64 value
+ * @return A Uint16 instance
+ * @throws NullPointerException if uint is null
+ * @throws IllegalArgumentException if uint is greater than 65535.
+ */
public static Uint16 valueOf(final Uint64 uint) {
return valueOf(uint.longValue());
}
+ /**
+ * Returns an {@code Uint16} holding the value of the specified {@code String}, parsed as an unsigned {@code int}
+ * value.
+ *
+ * @param string String to parse
+ * @return A Uint16 instance
+ * @throws NullPointerException if string is null
+ * @throws IllegalArgumentException if the parsed value is less than zero or greater than 65535
+ * @throws NumberFormatException if the string does not contain a parsable unsigned {@code int} value.
+ */
public static Uint16 valueOf(final String string) {
return valueOf(string, 10);
}
+ /**
+ * Returns an {@code Uint16} holding the value of the specified {@code String}, parsed as an unsigned {@code int}
+ * value.
+ *
+ * @param string String to parse
+ * @param radix Radix to use
+ * @return A Uint16 instance
+ * @throws NullPointerException if string is null
+ * @throws IllegalArgumentException if the parsed value is less than zero or greater than 65535
+ * @throws NumberFormatException if the string does not contain a parsable unsigned {@code int} value, or if the
+ * {@code radix} is outside of allowed range.
+ */
public static Uint16 valueOf(final String string, final int radix) {
- return valueOf(Integer.parseInt(string, radix));
+ return valueOf(Integer.parseInt(requireNonNull(string), radix));
}
+ /**
+ * {@inheritDoc}
+ *
+ * <p>
+ * The inverse operation is {@link #fromShortBits(short)}. In case this value is greater than
+ * {@link Short#MAX_VALUE}, the returned value will be equal to {@code this - 2^16}.
+ */
@Override
public final short shortValue() {
return value;
@Override
@SuppressWarnings("checkstyle:parameterName")
public final int compareTo(final Uint16 o) {
- return Integer.compare(intValue(), o.intValue());
+ return Short.compareUnsigned(value, o.value);
+ }
+
+ @Override
+ public final String toCanonicalString() {
+ return Integer.toString(intValue());
+ }
+
+ @Override
+ public final CanonicalValueSupport<Uint16> support() {
+ return SUPPORT;
+ }
+
+ /**
+ * Return an interned (shared) instance equivalent to this object. This may return the same object.
+ *
+ * @return A shared instance.
+ */
+ public final Uint16 intern() {
+ return intValue() < CACHE_SIZE ? this : INTERNER.intern(this);
+ }
+
+ /**
+ * Convert this value to an {@code int}.
+ *
+ * @return An int
+ */
+ public final int toJava() {
+ return intValue();
}
@Override
}
@Override
- public final boolean equals(final Object obj) {
+ public final boolean equals(final @Nullable Object obj) {
return this == obj || obj instanceof Uint16 && value == ((Uint16)obj).value;
}
@Override
public final String toString() {
- return String.valueOf(intValue());
+ return toCanonicalString();
}
private Object readResolve() {
Code Review / yangtools.git / blobdiff