org.opendaylight.yangtools.binding.lib.AbstractOpaqueObject Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2019 PANTHEON.tech, s.r.o. 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.binding.lib;

import com.google.common.annotations.Beta;
import com.google.common.base.MoreObjects;
import com.google.common.base.MoreObjects.ToStringHelper;
import org.eclipse.jdt.annotation.NonNull;
import org.opendaylight.yangtools.binding.OpaqueData;
import org.opendaylight.yangtools.binding.OpaqueObject;

/**
 * Utility base class for {@link OpaqueObject} implementations. This class provides baseline implementation of
 * {@link #hashCode()} and {@link #equals(Object)} as specified by {@link OpaqueObject}.
 *
 * @param  Implemented OpaqueObject type
 */
@Beta
public abstract class AbstractOpaqueObject> implements OpaqueObject {
    @Override
    public final int hashCode() {
        return 31 * implementedInterface().hashCode() + valueHashCode();
    }

    @Override
    public final boolean equals(final Object obj) {
        return this == obj || obj instanceof OpaqueObject other
            && implementedInterface().equals(other.implementedInterface()) && valueEquals(other.getValue());
    }

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

    protected ToStringHelper addToStringAttributes(final ToStringHelper helper) {
        return helper.add("value", getValue());
    }

    protected boolean valueEquals(final @NonNull OpaqueData otherValue) {
        return getValue().equals(otherValue);
    }

    protected int valueHashCode() {
        return getValue().hashCode();
    }
}