*/
package org.opendaylight.controller.cluster.access.concepts;
+import static com.google.common.base.Preconditions.checkArgument;
+import static com.google.common.base.Verify.verifyNotNull;
+import static java.util.Objects.requireNonNull;
+
import com.google.common.annotations.Beta;
+import com.google.common.base.MoreObjects;
+import com.google.common.base.Strings;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+import java.io.DataInput;
+import java.io.DataOutput;
+import java.io.Externalizable;
+import java.io.IOException;
+import java.io.ObjectInput;
+import java.io.ObjectOutput;
+import java.nio.charset.StandardCharsets;
import java.util.regex.Pattern;
-import javax.annotation.Nonnull;
+import org.eclipse.jdt.annotation.NonNull;
import org.opendaylight.yangtools.concepts.Identifier;
+import org.opendaylight.yangtools.concepts.WritableIdentifier;
/**
* An {@link Identifier} identifying a data store frontend type, which is able to access the data store backend.
* @author Robert Varga
*/
@Beta
-public interface FrontendType extends Identifier {
- Pattern SIMPLE_STRING_PATTERN = Pattern.compile("[a-zA-Z-_.*+:=,!~';]+");
+public final class FrontendType implements Comparable<FrontendType>, WritableIdentifier {
+ private static final class Proxy implements Externalizable {
+ private static final long serialVersionUID = 1L;
+ private byte[] serialized;
+
+ // checkstyle flags the public modifier as redundant however it is explicitly needed for Java serialization to
+ // be able to create instances via reflection.
+ @SuppressWarnings("checkstyle:RedundantModifier")
+ public Proxy() {
+ // For Externalizable
+ }
+
+ Proxy(final byte[] serialized) {
+ this.serialized = requireNonNull(serialized);
+ }
+
+ @Override
+ public void writeExternal(final ObjectOutput out) throws IOException {
+ out.writeInt(serialized.length);
+ out.write(serialized);
+ }
+
+ @Override
+ public void readExternal(final ObjectInput in) throws IOException {
+ serialized = new byte[in.readInt()];
+ in.readFully(serialized);
+ }
+
+ private Object readResolve() {
+ // TODO: consider caching instances here
+ return new FrontendType(new String(serialized, StandardCharsets.UTF_8), serialized);
+ }
+ }
+
+ private static final String SIMPLE_STRING_REGEX = "^[a-zA-Z0-9-_.*+:=,!~';]+$";
+ private static final Pattern SIMPLE_STRING_PATTERN = Pattern.compile(SIMPLE_STRING_REGEX);
+ private static final long serialVersionUID = 1L;
+
+ private final @NonNull String name;
+
+ @SuppressFBWarnings(value = "VO_VOLATILE_REFERENCE_TO_ARRAY",
+ justification = "The array elements are non-volatile but we don't access them.")
+ private volatile byte[] serialized;
+
+ private FrontendType(final String name) {
+ this.name = requireNonNull(name);
+ }
+
+ FrontendType(final String name, final byte[] serialized) {
+ this(name);
+ this.serialized = verifyNotNull(serialized);
+ }
/**
- * Return a string representation of this frontend type. Unlike {@link #toString()}, returned string has
- * restricted rules on what it can contain:
- * - US-ASCII letters
+ * Return a {@link FrontendType} corresponding to a string representation. Input string has constraints
+ * on what characters it can contain. It may contain the following:
+ * - US-ASCII letters and numbers
* - special characters: -_.*+:=,!~';
*
- * A validation pattern for this string is available as {@link #SIMPLE_STRING_PATTERN}.
+ * @param name the input name
+ * @return A {@link FrontendType} instance
+ * @throws IllegalArgumentException if the string is null, empty or contains invalid characters
*/
- @Nonnull String toSimpleString();
+ public static @NonNull FrontendType forName(final String name) {
+ checkArgument(!Strings.isNullOrEmpty(name));
+ checkArgument(SIMPLE_STRING_PATTERN.matcher(name).matches(),
+ "Supplied name %s does not patch pattern %s", name, SIMPLE_STRING_REGEX);
+ return new FrontendType(name);
+ }
+
+ public static @NonNull FrontendType readFrom(final DataInput in) throws IOException {
+ final byte[] serialized = new byte[in.readInt()];
+ in.readFully(serialized);
+ return new FrontendType(new String(serialized, StandardCharsets.UTF_8));
+ }
+
+ @Override
+ public void writeTo(final DataOutput out) throws IOException {
+ final byte[] local = getSerialized();
+ out.writeInt(local.length);
+ out.write(local);
+ }
+
+ public @NonNull String getName() {
+ return name;
+ }
+
+ public org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.cds.types.rev191024
+ . @NonNull FrontendType toYang() {
+ return new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.cds.types.rev191024
+ .FrontendType(name);
+ }
+
+ @Override
+ public int hashCode() {
+ return name.hashCode();
+ }
+
+ @Override
+ public boolean equals(final Object obj) {
+ return this == obj || obj instanceof FrontendType && name.equals(((FrontendType)obj).name);
+ }
+
+ @Override
+ public int compareTo(final FrontendType obj) {
+ return this == obj ? 0 : name.compareTo(obj.name);
+ }
+
+ @Override
+ public String toString() {
+ return MoreObjects.toStringHelper(FrontendType.class).add("name", name).toString();
+ }
+
+ private byte[] getSerialized() {
+ byte[] local = serialized;
+ if (local == null) {
+ local = name.getBytes(StandardCharsets.UTF_8);
+ serialized = local;
+ }
+ return local;
+ }
+
+ Object writeReplace() {
+ return new Proxy(getSerialized());
+ }
}
Code Review / controller.git / blobdiff