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

Introduction

Here is the source code for com.zimbra.soap.mail.message.DismissCalendarItemAlarmRequest.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.XmlElement;
import javax.xml.bind.annotation.XmlElements;
import javax.xml.bind.annotation.XmlRootElement;

import com.zimbra.common.soap.MailConstants;
import com.zimbra.soap.mail.type.DismissAlarm;
import com.zimbra.soap.mail.type.DismissAppointmentAlarm;
import com.zimbra.soap.mail.type.DismissTaskAlarm;

/**
 * @zm-api-command-auth-required true
 * @zm-api-command-admin-auth-required false
 * @zm-api-command-description Dismiss calendar item alarm
 */
@XmlAccessorType(XmlAccessType.NONE)
@XmlRootElement(name = MailConstants.E_DISMISS_CALITEM_ALARM_REQUEST)
public class DismissCalendarItemAlarmRequest {

    /**
     * @zm-api-field-description Details of alarms to dismiss
     */
    @XmlElements({ @XmlElement(name = MailConstants.E_APPOINTMENT /* appt */, type = DismissAppointmentAlarm.class),
            @XmlElement(name = MailConstants.E_TASK /* task */, type = DismissTaskAlarm.class) })
    private List<DismissAlarm> alarms = Lists.newArrayList();

    public DismissCalendarItemAlarmRequest() {
    }

    public void setAlarms(Iterable<DismissAlarm> alarms) {
        this.alarms.clear();
        if (alarms != null) {
            Iterables.addAll(this.alarms, alarms);
        }
    }

    public DismissCalendarItemAlarmRequest addAlarm(DismissAlarm alarm) {
        this.alarms.add(alarm);
        return this;
    }

    public List<DismissAlarm> getAlarms() {
        return Collections.unmodifiableList(alarms);
    }

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

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