org.zanata.rest.dto.resource.TextFlow Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of zanata-common-api Show documentation
Zanata API definitions
There is a newer version: 4.6.2
package org.zanata.rest.dto.resource;

import java.io.Serializable;
import java.util.List;

import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlElementWrapper;
import javax.xml.bind.annotation.XmlType;
import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;

import com.webcohesion.enunciate.metadata.DocumentationExample;
import com.webcohesion.enunciate.metadata.Label;
import org.codehaus.jackson.annotate.JsonIgnore;
import org.codehaus.jackson.annotate.JsonIgnoreProperties;
import org.codehaus.jackson.annotate.JsonPropertyOrder;
import org.codehaus.jackson.map.annotate.JsonSerialize;
import org.hibernate.validator.constraints.NotEmpty;
import org.zanata.common.LocaleId;
import org.zanata.common.Namespaces;
import org.zanata.rest.dto.DTOUtil;
import org.zanata.rest.dto.Extensible;
import org.zanata.rest.dto.LocaleIdAdapter;
import org.zanata.rest.dto.extensions.gettext.TextFlowExtension;

/**
 * A translatable string
 */
@XmlType(name = "textFlowType", propOrder = { "content", "contents", "plural",
        "extensions" })
@JsonPropertyOrder({ "id", "lang", "content", "contents", "plural",
        "extensions" })
@JsonIgnoreProperties(ignoreUnknown = true)
@JsonSerialize(include = JsonSerialize.Inclusion.NON_NULL)
@Label("Text Flow")
public class TextFlow extends TextContainer implements
        Extensible, Serializable {
    private static final long serialVersionUID = 1L;

    @NotEmpty
    @Size(max = 255)
    private String id;

    @NotNull
    private LocaleId lang;

    private ExtensionSet extensions;

    private Integer revision;
    private boolean plural;

    /**
     * This constructor sets the lang value to en-US
     *
     */

    public TextFlow() {
        this(null, null, (String) null);
    }

    /**
     * This constructor sets the lang value to en-US
     *
     */

    public TextFlow(String id) {
        this(id, LocaleId.EN_US, (String) null);
    }

    /**
     *
     * @param id
     *            Resource Id value
     * @param lang
     *            Locale value
     */

    public TextFlow(String id, LocaleId lang) {
        this(id, lang, (String) null);
    }

    public TextFlow(String id, LocaleId lang, String... content) {
        this.id = id;
        this.lang = lang;
        setContents(content);
    }

    public TextFlow(String id, LocaleId lang, List contentList) {
        this.id = id;
        this.lang = lang;
        setContents(contentList);
    }

    @XmlAttribute(name = "id", required = true)
    @DocumentationExample("abc123")
    public String getId() {
        return id;
    }

    public void setId(String id) {
        this.id = id;
    }

    /**
     * Whether this message supports plurals
     */
    @XmlElement(namespace = Namespaces.ZANATA_OLD)
    public boolean isPlural() {
        return plural;
    }

    /**
     * @param pluralSupported
     *            the pluralSupported to set
     */
    public void setPlural(boolean pluralSupported) {
        this.plural = pluralSupported;
    }

    /**
     * Locale code for this text flow.
     */
    @XmlJavaTypeAdapter(type = LocaleId.class, value = LocaleIdAdapter.class)
    @XmlAttribute(name = "lang", namespace = Namespaces.XML, required = false)
    @DocumentationExample("es-ES")
    public LocaleId getLang() {
        return lang;
    }

    public void setLang(LocaleId lang) {
        this.lang = lang;
    }

    @XmlElementWrapper(name = "extensions", required = false,
            namespace = Namespaces.ZANATA_OLD)
    @XmlElement(name = "extension", namespace = Namespaces.ZANATA_OLD)
    public ExtensionSet getExtensions() {
        return extensions;
    }

    public void setExtensions(ExtensionSet extensions) {
        this.extensions = extensions;
    }

    @JsonIgnore
    public ExtensionSet getExtensions(boolean createIfNull) {
        if (createIfNull && extensions == null)
            extensions = new ExtensionSet();
        return extensions;
    }

    @Override
    public String toString() {
        return DTOUtil.toXML(this);
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int result = super.hashCode();
        result =
                prime * result
                        + ((extensions == null) ? 0 : extensions.hashCode());
        result = prime * result + ((id == null) ? 0 : id.hashCode());
        result = prime * result + ((lang == null) ? 0 : lang.hashCode());
        result =
                prime * result + ((revision == null) ? 0 : revision.hashCode());
        return result;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (!super.equals(obj)) {
            return false;
        }
        if (!(obj instanceof TextFlow)) {
            return false;
        }
        TextFlow other = (TextFlow) obj;
        if (extensions == null) {
            if (other.extensions != null) {
                return false;
            }
        } else if (!extensions.equals(other.extensions)) {
            return false;
        }
        if (id == null) {
            if (other.id != null) {
                return false;
            }
        } else if (!id.equals(other.id)) {
            return false;
        }
        if (lang == null) {
            if (other.lang != null) {
                return false;
            }
        } else if (!lang.equals(other.lang)) {
            return false;
        }
        if (revision == null) {
            if (other.revision != null) {
                return false;
            }
        } else if (!revision.equals(other.revision)) {
            return false;
        }
        return true;
    }

    @XmlAttribute()
    public Integer getRevision() {
        return revision;
    }

    public void setRevision(Integer i) {
        revision = i;
    }

}