com.zimbra.soap.admin.message.BackupQueryResponse.java Source code

Introduction

Here is the source code for com.zimbra.soap.admin.message.BackupQueryResponse.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.admin.message;

import java.util.List;

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

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 javax.xml.bind.annotation.XmlType;

import com.zimbra.common.soap.BackupConstants;
import com.zimbra.soap.admin.type.BackupQueryInfo;
import com.zimbra.soap.type.ZmBoolean;

@XmlAccessorType(XmlAccessType.NONE)
@XmlRootElement(name = BackupConstants.E_BACKUP_QUERY_RESPONSE)
@XmlType(propOrder = {})
public class BackupQueryResponse {

    /**
     * @zm-api-field-tag total-space-bytes
     * @zm-api-field-description total space on the backup target volume in bytes
     */
    @XmlAttribute(name = BackupConstants.A_TOTAL_SPACE /* totalSpace */, required = true)
    private final long totalSpace;

    /**
     * @zm-api-field-tag free-space-bytes
     * @zm-api-field-description Free space on the backup target volume in bytes
     */
    @XmlAttribute(name = BackupConstants.A_FREE_SPACE /* freeSpace */, required = true)
    private final long freeSpace;

    /**
     * @zm-api-field-tag more-backups
     * @zm-api-field-description Present with value <b>1 (true)</b> there are more backups to page through
     */
    @XmlAttribute(name = BackupConstants.A_MORE /* more */, required = false)
    private ZmBoolean more;

    /**
     * @zm-api-field-description Backup information
     */
    @XmlElement(name = BackupConstants.E_BACKUP /* backup */, required = false)
    private List<BackupQueryInfo> backups = Lists.newArrayList();

    /**
     * no-argument constructor wanted by JAXB
     */
    @SuppressWarnings("unused")
    private BackupQueryResponse() {
        this(-1L, -1L);
    }

    public BackupQueryResponse(long totalSpace, long freeSpace) {
        this.totalSpace = totalSpace;
        this.freeSpace = freeSpace;
    }

    public void setMore(Boolean more) {
        this.more = ZmBoolean.fromBool(more);
    }

    public void setBackups(Iterable<BackupQueryInfo> backups) {
        this.backups.clear();
        if (backups != null) {
            Iterables.addAll(this.backups, backups);
        }
    }

    public void addBackup(BackupQueryInfo backup) {
        this.backups.add(backup);
    }

    public long getTotalSpace() {
        return totalSpace;
    }

    public long getFreeSpace() {
        return freeSpace;
    }

    public Boolean getMore() {
        return ZmBoolean.toBool(more);
    }

    public List<BackupQueryInfo> getBackups() {
        return backups;
    }

    public Objects.ToStringHelper addToStringInfo(Objects.ToStringHelper helper) {
        return helper.add("totalSpace", totalSpace).add("freeSpace", freeSpace).add("more", more).add("backups",
                backups);
    }

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