com.sun.mail.imap.ModifiedSinceTerm Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2017 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://oss.oracle.com/licenses/CDDL+GPL-1.1
* or LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.mail.imap;
import javax.mail.Message;
import javax.mail.search.SearchTerm;
/**
* Find messages that have been modified since a given MODSEQ value.
* Relies on the server implementing the CONDSTORE extension
* (RFC 4551).
*
* @since JavaMail 1.5.1
* @author Bill Shannon
*/
public final class ModifiedSinceTerm extends SearchTerm {
private long modseq;
private static final long serialVersionUID = 5151457469634727992L;
/**
* Constructor.
*
* @param modseq modification sequence number
*/
public ModifiedSinceTerm(long modseq) {
this.modseq = modseq;
}
/**
* Return the modseq.
*
* @return the modseq
*/
public long getModSeq() {
return modseq;
}
/**
* The match method.
*
* @param msg the date comparator is applied to this Message's
* MODSEQ
* @return true if the comparison succeeds, otherwise false
*/
@Override
public boolean match(Message msg) {
long m;
try {
if (msg instanceof IMAPMessage)
m = ((IMAPMessage)msg).getModSeq();
else
return false;
} catch (Exception e) {
return false;
}
return m >= modseq;
}
/**
* Equality comparison.
*/
@Override
public boolean equals(Object obj) {
if (!(obj instanceof ModifiedSinceTerm))
return false;
return modseq == ((ModifiedSinceTerm)obj).modseq;
}
/**
* Compute a hashCode for this object.
*/
@Override
public int hashCode() {
return (int)modseq;
}
}