org.jopendocument.util.cache.CacheResult Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jOpenDocument Show documentation
Show all versions of jOpenDocument Show documentation
jOpenDocument is a free library for developers looking to use
Open Document files without OpenOffice.org.
The newest version!
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 2008-2013 jOpenDocument, by ILM Informatique. All rights reserved.
*
* The contents of this file are subject to the terms of the GNU
* General Public License Version 3 only ("GPL").
* You may not use this file except in compliance with the License.
* You can obtain a copy of the License at http://www.gnu.org/licenses/gpl-3.0.html
* 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.
*
*/
package org.jopendocument.util.cache;
/**
* Represent the result of a query to a cache. Allow one to know if the queried key was not in
* cache, or the thread was interrupted or of course if the result was in cache.
*
* @author Sylvain
*
* @param type of value.
*/
public final class CacheResult {
private static final CacheResult INTERRUPTED = new CacheResult(State.INTERRUPTED);
private static final CacheResult NOT_IN_CACHE = new CacheResult(State.NOT_IN_CACHE);
@SuppressWarnings("unchecked")
static final CacheResult getNotInCache() {
return NOT_IN_CACHE;
}
@SuppressWarnings("unchecked")
static final CacheResult getInterrupted() {
return INTERRUPTED;
}
public enum State {
VALID, NOT_IN_CACHE, INTERRUPTED
};
private final State state;
private final V res;
private CacheResult(State state,/* K key, */V res) {
this.state = state;
this.res = res;
}
CacheResult(V res) {
this(State.VALID, res);
}
CacheResult(State state) {
this(state, null);
}
public V getRes() {
if (this.state == State.VALID)
return this.res;
else
throw new IllegalStateException(this + " is not valid : " + this.getState());
}
public State getState() {
return this.state;
}
@Override
public String toString() {
return this.getClass().getSimpleName() + " " + this.getState();
}
}