com.ardikars.common.util.MultipleObject Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of common-util Show documentation
Common util
The newest version!
/**
 * Copyright 2017-2019 the original author or authors.
 *
 * 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 com.ardikars.common.util;

import com.ardikars.common.annotation.Immutable;
import java.io.Serializable;
import java.util.Arrays;
import java.util.HashSet;
import java.util.Objects;
import java.util.Set;

/**
 * Multiple keys for {@code java.util.Map}
 *
 * @see java.util.Map
 * @see NamedMultipleObject
 * @param  key type.
 */
@Immutable
public class MultipleObject implements Serializable {

    private static final long serialVersionUID = -7486266343955776290L;

    private final Set keys;

    protected MultipleObject(Set keys) {
        this.keys = keys;
    }

    /**
     * Create {@code MultiKey} object.
     * @param keys keys.
     * @param  key type.
     * @return returns {@code MultiKey} object.
     */
    @SuppressWarnings("unchecked")
    public static  MultipleObject of(K... keys) {
        return new MultipleObject(new HashSet(Arrays.asList(keys)));
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (!(o instanceof MultipleObject)) {
            return false;
        }
        MultipleObject multiKey = (MultipleObject) o;
        return Objects.equals(keys, multiKey.keys);
    }

    @Override
    public int hashCode() {
        return Objects.hash(keys);
    }

    @Override
    public String toString() {
        return String.valueOf(keys);
    }

}