no.digipost.util.JustALong Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of digg Show documentation
Some stellar general purpose utils.
The newest version!
/*
 * Copyright (C) Posten Norge AS
 *
 * 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 no.digipost.util;

import no.digipost.function.SerializableFunction;

import java.io.Serializable;
import java.util.Objects;

/**
 * Base class for creating simple "typed {@code long}" value classes, for cases
 * when you do not want to pass around simple {@code long}s for numbers that has
 * certain (business-) semantics in your application, even though a {@code long}
 * does adequately express the value. By extending this class you do not have to
 * implement the equals and hashcode. You would not refer to this class
 * other than with an {@code extends JustALong} decalaration in your class definition.
 *
 * This is a special case implementation of {@link JustA} to avoid the boxing cost
 * for primitive {@code long}s. The typical use for this are for ids, and classes
 * where instances are uniquely distinguished by their {@code long} ids, and equals/hashcode
 * will exercise correct behavior when only operating on the id. Any additional
 * fields in an extending class should usually be declared {@code final}.
 *
 * A common pattern for using this class would be:
 *
 *  * interface WithId {
 *
 *   static JustAnId of(long id) {
 *     return new JustAnId(id);
 *   }
 *
 *   final class JustAnId extends JustALong implements WithId {
 *
 *      private JustAnId(String id) {
 *        super(id);
 *      }
 *
 *      public long getId() {
 *        return theValue;
 *      }
 *    }
 *
 *
 *    long getId();
 * }
 *
 * @see JustA {@code JustA} is the generic version for any (reference-) type.
 */
public abstract class JustALong implements Serializable {

    private static final long serialVersionUID = 1L;

    protected final long theLong;

    private final String description;
    private final SerializableFunction toString;


    protected JustALong(long theValue) {
        this(theValue, Object::toString);
    }

    protected JustALong(long theValue, String description) {
        this(theValue, description, Object::toString);
    }

    protected JustALong(long theValue, SerializableFunction  valueToString) {
        this(theValue, null, valueToString);
    }

    protected JustALong(long theValue, String description, SerializableFunction valueToString) {
        this.theLong = theValue;
        this.description = description != null ? description : getClass().getSimpleName();
        this.toString = valueToString;
    }


    @Override
    public final boolean equals(Object obj) {
        if (this == obj) {
            return true;
        } else if (obj instanceof JustALong && getClass().isInstance(obj)) {
            JustALong that = (JustALong) obj;
            return Objects.equals(this.theLong, that.theLong);
        }
        return false;
    }

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

    @Override
    public String toString() {
        return description + " '" + toString.apply(theLong) + "'";
    }
}