com.zimbra.soap.mail.message.AutoCompleteResponse.java Source code

Introduction

Here is the source code for com.zimbra.soap.mail.message.AutoCompleteResponse.java

Source

/*
 * ***** BEGIN LICENSE BLOCK *****
 * Zimbra Collaboration Suite Server
 * Copyright (C) 2011, 2012, 2013, 2014, 2016 Synacor, Inc.
 *
 * This program 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,
 * version 2 of the License.
 *
 * This program 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 this program.
 * If not, see <https://www.gnu.org/licenses/>.
 * ***** END LICENSE BLOCK *****
 */

package com.zimbra.soap.mail.message;

import com.google.common.base.Objects;
import com.google.common.collect.Iterables;
import com.google.common.collect.Lists;

import java.util.Collections;
import java.util.List;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;

import com.zimbra.common.soap.MailConstants;
import com.zimbra.soap.mail.type.AutoCompleteMatch;
import com.zimbra.soap.type.ZmBoolean;

@XmlAccessorType(XmlAccessType.NONE)
@XmlRootElement(name = MailConstants.E_AUTO_COMPLETE_RESPONSE)
public class AutoCompleteResponse {

    /**
     * @zm-api-field-tag can-be-cached
     * @zm-api-field-description Flag whether can be cached
     */
    @XmlAttribute(name = MailConstants.A_CANBECACHED /* canBeCached */, required = false)
    private ZmBoolean canBeCached;

    /**
     * @zm-api-field-description Matches
     */
    @XmlElement(name = MailConstants.E_MATCH /* match */, required = false)
    private List<AutoCompleteMatch> matches = Lists.newArrayList();

    public AutoCompleteResponse() {
    }

    public void setCanBeCached(Boolean canBeCached) {
        this.canBeCached = ZmBoolean.fromBool(canBeCached);
    }

    public void setMatches(Iterable<AutoCompleteMatch> matches) {
        this.matches.clear();
        if (matches != null) {
            Iterables.addAll(this.matches, matches);
        }
    }

    public AutoCompleteResponse addMatche(AutoCompleteMatch matche) {
        this.matches.add(matche);
        return this;
    }

    public Boolean getCanBeCached() {
        return ZmBoolean.toBool(canBeCached);
    }

    public List<AutoCompleteMatch> getMatches() {
        return Collections.unmodifiableList(matches);
    }

    public Objects.ToStringHelper addToStringInfo(Objects.ToStringHelper helper) {
        return helper.add("canBeCached", canBeCached).add("matches", matches);
    }

    @Override
    public String toString() {
        return addToStringInfo(Objects.toStringHelper(this)).toString();
    }
}