org.opendaylight.yangtools.util.AbstractIdentifier Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of yangtools-docs Show documentation

YANG Tools documentation

There is a newer version: 14.0.4

/*
 * Copyright (c) 2016 Cisco Systems, Inc. and others.  All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */
package org.opendaylight.yangtools.util;

import static java.util.Objects.requireNonNull;

import com.google.common.base.MoreObjects;
import org.eclipse.jdt.annotation.NonNull;
import org.opendaylight.yangtools.concepts.Identifier;

/**
 * An abstract {@link Identifier} backed by an immutable object. Subclasses have no control over {@link #hashCode()}
 * and {@link #equals(Object)}, hence they should not add any fields.
 *
 * @param  Object type
 */
public abstract class AbstractIdentifier implements Identifier {
    @java.io.Serial
    private static final long serialVersionUID = 1L;

    private final @NonNull T value;

    public AbstractIdentifier(final @NonNull T value) {
        this.value = requireNonNull(value);
    }

    protected final @NonNull T getValue() {
        return value;
    }

    @Override
    public final int hashCode() {
        return value.hashCode();
    }

    @Override
    public final boolean equals(final Object obj) {
        if (this == obj) {
            return true;
        }
        return obj != null && getClass().equals(obj.getClass()) && value.equals(((AbstractIdentifier)obj).value);
    }

    @Override
    public final @NonNull String toString() {
        return MoreObjects.toStringHelper(this).add("value", value).toString();
    }
}