cat.albirar.framework.sets.registry.impl.NamedSetDefaultImpl.java Source code

Introduction

Here is the source code for cat.albirar.framework.sets.registry.impl.NamedSetDefaultImpl.java

Source

/*
 * This file is part of "albirar-framework".
 * 
 * "albirar-framework" is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * "albirar-framework" is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with calendar.  If not, see <http://www.gnu.org/licenses/>.
 *
 * Copyright (C) 2015 Octavi Forns
 */

package cat.albirar.framework.sets.registry.impl;

import org.springframework.util.Assert;
import org.springframework.util.ObjectUtils;

import cat.albirar.framework.sets.ISet;
import cat.albirar.framework.sets.impl.SetDefaultImpl;
import cat.albirar.framework.sets.registry.INamedSet;

/**
 * Default implementation of a {@link INamedSet}.
 * @author Octavi Forns ofornes@albirar.cat
 * @since 2.1.0
 */
public class NamedSetDefaultImpl<T> extends SetDefaultImpl<T> implements INamedSet<T> {
    private static final long serialVersionUID = 3227604849293846449L;
    private String name;

    /**
     * Constructor.
     * @param modelRoot
     * @param name The name for this set
     */
    public NamedSetDefaultImpl(Class<? extends T> modelRoot, String name) {
        super(modelRoot);
        Assert.hasText(name, "The name is a required argument, cannot be null, nor empty nor whitespace!");
        this.name = name;
    }

    /**
     * Copy constructor.
     * @param origin The origin, required
     * @param name The name for this set
     */
    public NamedSetDefaultImpl(ISet<T> origin, String name) {
        super(origin);
        Assert.hasText(name, "The name is a required argument, cannot be null, nor empty nor whitespace!");
        this.name = name;
    }

    /**
     * {@inheritDocs}
     */
    @Override
    public String getName() {
        return name;
    }

    /**
     * Add the {@link #getName()} on equals algorithm.
     * 
     * {@inheritDoc}
     */
    @Override
    public boolean equals(Object o) {
        if (o == this) {
            return true;
        }
        if (o == null) {
            return false;
        }

        if (INamedSet.class.isAssignableFrom(o.getClass())) {
            return (ObjectUtils.nullSafeEquals(name, ((INamedSet<?>) o).getName()) && super.equals(o));
        }
        return false;
    }

    @Override
    protected String toStringProperties() {
        return ("name=" + name + ", " + super.toStringProperties());
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public int compareTo(INamedSet<T> o) {
        return (getName().compareTo(o.getName()));
    }

}