org.apache.james.imap.message.response.CapabilityResponse Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of protocols-imap Show documentation
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.message.response;

import java.util.Set;

import org.apache.james.imap.api.message.response.ImapResponseMessage;

/**
 * A CAPABILITY response. See 7.2.1 of RFC2060.
 */
public class CapabilityResponse implements ImapResponseMessage {

    private final Set capabilities;

    /**
     * Constructs a response based on the given capabilities.
     * 
     * @param capabilities
     *            not null
     */
    public CapabilityResponse(final Set capabilities) {
        super();
        this.capabilities = capabilities;
    }

    /**
     * Gets a {@link Set} containing the capabilities of this server.
     * 
     * @return not null
     */
    public Set getCapabilities() {
        return capabilities;
    }

    @Override
    public int hashCode() {
        final int PRIME = 31;
        int result = 1;
        result = PRIME * result + ((capabilities == null) ? 0 : capabilities.hashCode());
        return result;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;
        if (getClass() != obj.getClass())
            return false;
        final CapabilityResponse other = (CapabilityResponse) obj;
        if (capabilities == null) {
            if (other.capabilities != null)
                return false;
        } else if (!capabilities.equals(other.capabilities))
            return false;
        return true;
    }

    /**
     * Renders a description suitable for debugging.
     * 
     * @return a description suitable for debugging
     */
    public String toString() {
        final String retValue = "CapabilityResponse ( " + "capabilities = " + this.capabilities + " )";

        return retValue;
    }

}