org.zanata.rest.dto.GlossaryLocaleInfo 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;

import java.io.Serializable;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;

import com.webcohesion.enunciate.metadata.DocumentationExample;
import com.webcohesion.enunciate.metadata.Label;
import org.codehaus.jackson.annotate.JsonIgnoreProperties;
import org.codehaus.jackson.annotate.JsonPropertyOrder;
import org.codehaus.jackson.map.annotate.JsonSerialize;
import org.zanata.common.Namespaces;

/**
 * @author Alex Eng [email protected]
 */
@XmlRootElement(name = "glossaryLocaleInfo")
@XmlType(name = "glossaryLocaleInfoType", propOrder = { "locale", "numberOfTerms" })
@JsonIgnoreProperties(ignoreUnknown = true)
@JsonPropertyOrder({ "locale", "numberOfTerms"})
@JsonSerialize(include = JsonSerialize.Inclusion.NON_NULL)
@Label("Glossary Locale Info")
public class GlossaryLocaleInfo implements Serializable {
    private static final long serialVersionUID = 7486128063191358182L;
    private LocaleDetails locale;
    private int numberOfTerms;

    public GlossaryLocaleInfo() {
        this(null, 0);
    }

    public GlossaryLocaleInfo(LocaleDetails locale, int numberOfTerms) {
        this.locale = locale;
        this.numberOfTerms = numberOfTerms;
    }

    @XmlElement(name = "locale", required = false,
        namespace = Namespaces.ZANATA_API)
    public LocaleDetails getLocale() {
        return locale;
    }

    public void setLocale(LocaleDetails locale) {
        this.locale = locale;
    }

    /**
     * Number of terms available for the glossary in this locale
     */
    @XmlElement(name = "numberOfTerms", required = false,
        namespace = Namespaces.ZANATA_API)
    @DocumentationExample("2")
    public int getNumberOfTerms() {
        return numberOfTerms;
    }

    public void setNumberOfTerms(int numberOfTerms) {
        this.numberOfTerms = numberOfTerms;
    }
}