org.apache.james.imap.message.response.SearchResponse 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.Arrays;

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

/**
 * A SEARCH response.
 */
public class SearchResponse implements ImapResponseMessage {
    private final long ids[];
    private final Long highestModSeq;

    /**
     * Constructs a SEARCH response.
     * 
     * @param ids ids, not null
     * @param highestModSeq
     */
    public SearchResponse(final long[] ids, Long highestModSeq) {
        super();
        this.ids = ids;
        this.highestModSeq = highestModSeq;
    }

    /**
     * Gets the ids returned by this search.
     * 
     * @return the ids, not null
     */
    public final long[] getIds() {
        return ids;
    }
    
    /**
     * Return the highest mod-sequence for which matched the search. This is only set if the search included the MODSEQ 
     * parameter
     *  
     * @return highestMod
     */
    public final Long getHighestModSeq() {
        return highestModSeq;
    }
    

    /**
     * @see java.lang.Object#hashCode()
     */
    // @Override
    public int hashCode() {
        return ids.length;
    }

    /**
     * @see java.lang.Object#equals(java.lang.Object)
     */
    // @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;
        if (getClass() != obj.getClass())
            return false;
        final SearchResponse other = (SearchResponse) obj;
        if (!Arrays.equals(ids, other.ids))
            return false;
        if (highestModSeq != other.highestModSeq) 
            return false;
        return true;
    }

    /**
     * Constructs a String with all attributes in name = value
     * format.
     * 
     * @return a String representation of this object.
     */
    public String toString() {
        final String TAB = " ";

        StringBuffer retValue = new StringBuffer();

        retValue.append("SearchResponse ( ").append("ids = ").append(Arrays.toString(this.ids)).append(TAB).append(" )");

        return retValue.toString();
    }
}