dk.dma.msinm.common.model.ILocalizedDesc.java Source code

Introduction

Here is the source code for dk.dma.msinm.common.model.ILocalizedDesc.java

Source

/* Copyright (c) 2011 Danish Maritime Authority
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this library.  If not, see <http://www.gnu.org/licenses/>.
 */
package dk.dma.msinm.common.model;

import org.apache.commons.lang.StringUtils;

/**
 * Interface to be implemented by the descriptive entities of localizable entities
 */
public interface ILocalizedDesc<E extends ILocalizable> {

    /**
     * Returns the language of this descriptive entity
     * @return the language of this descriptive entity
     */
    String getLang();

    /**
     * Sets the language of this descriptive entity
     * @param lang the language of this descriptive entity
     */
    void setLang(String lang);

    /**
     * Copies the description values from the desc entity to this entity
     * @param desc the description entity to copy from
     */
    void copyDesc(ILocalizedDesc desc);

    /**
     * Returns if this descriptive entity is defined, i.e. has at least one non-blank field
     * @return if this descriptive entity is defined
     */
    boolean descDefined();

    /**
     * Utility method that returns if at least one of the given fields in non-blank
     * @param fields the list of fields to check
     * @return if at least one of the given fields in non-blank
     */
    public static boolean fieldsDefined(String... fields) {
        for (String field : fields) {
            if (StringUtils.isNotBlank(field)) {
                return true;
            }
        }
        return false;
    }
}