org.apache.james.imap.api.message.StatusDataItems Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of protocols-imap
There is a newer version: 3.8.1
/****************************************************************
 * Licensed to the Apache Software Foundation (ASF) under one   *
 * or more contributor license agreements.  See the NOTICE file *
 * distributed with this work for additional information        *
 * regarding copyright ownership.  The ASF licenses this file   *
 * to you under the Apache License, Version 2.0 (the            *
 * "License"); you may not use this file except in compliance   *
 * with the License.  You may obtain a copy of the License at   *
 *                                                              *
 *   http://www.apache.org/licenses/LICENSE-2.0                 *
 *                                                              *
 * Unless required by applicable law or agreed to in writing,   *
 * software distributed under the License is distributed on an  *
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY       *
 * KIND, either express or implied.  See the License for the    *
 * specific language governing permissions and limitations      *
 * under the License.                                           *
 ****************************************************************/
package org.apache.james.imap.api.message;

import java.util.EnumSet;

import com.google.common.base.MoreObjects;

public class StatusDataItems {

    public static final String SIMPLE_NAME = StatusDataItems.class.getSimpleName();

    public enum StatusItem {
        // See https://www.rfc-editor.org/rfc/rfc7889.html
        APPENDLIMIT,
        MESSAGES,
        // https://www.rfc-editor.org/rfc/rfc8474.html#section-4.3
        MAILBOXID,
        RECENT,
        UID_NEXT,
        UID_VALIDITY,
        UNSEEN,
        HIGHEST_MODSEQ,
        // See https://www.iana.org/go/rfc8438
        SIZE,
        // See https://www.rfc-editor.org/rfc/rfc9208.html
        DELETED,
        // See https://www.rfc-editor.org/rfc/rfc9208.html
        DELETED_STORAGE
    }

    private final EnumSet statusItems;

    public StatusDataItems(EnumSet statusItems) {
        this.statusItems = statusItems;
    }

    public boolean isAppendLimit() {
        return statusItems.contains(StatusItem.APPENDLIMIT);
    }

    public boolean isMessages() {
        return statusItems.contains(StatusItem.MESSAGES);
    }

    public boolean isRecent() {
        return statusItems.contains(StatusItem.RECENT);
    }

    public boolean isUidNext() {
        return statusItems.contains(StatusItem.UID_NEXT);
    }

    public boolean isUidValidity() {
        return statusItems.contains(StatusItem.UID_VALIDITY);
    }

    public boolean isUnseen() {
        return statusItems.contains(StatusItem.UNSEEN);
    }

    public boolean isMailboxId() {
        return statusItems.contains(StatusItem.MAILBOXID);
    }
    
    public boolean isHighestModSeq() {
        return statusItems.contains(StatusItem.HIGHEST_MODSEQ);
    }

    public boolean isSize() {
        return statusItems.contains(StatusItem.SIZE);
    }

    public boolean isDeleted() {
        return statusItems.contains(StatusItem.DELETED);
    }

    public boolean isDeletedStorage() {
        return statusItems.contains(StatusItem.DELETED_STORAGE);
    }

    @Override
    public String toString() {
        return MoreObjects.toStringHelper(SIMPLE_NAME)
            .add("statusItems", statusItems)
            .toString();
    }
}