CacheStorage.java

/**
 * Copyright (C) 2009-2012 the original author or authors.
 * See the notice.md file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * Licensed 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.fusesource.restygwt.client.cache;

public interface CacheStorage<T> {
    public T getResultOrReturnNull(final CacheKey key);

    public T getResultOrReturnNull(final CacheKey key, final String scope);

    /**
     * default put method
     */
    public void putResult(final CacheKey key, final T response);

    /**
     * put by ident/scope. e.g. to invalidate later on by domain class
     *
     * @param key
     * @param scope
     * @param response
     */
    public void putResult(final CacheKey key, final T response, final String... scope);

    /**
     * default delete method
     */
    public void remove(final CacheKey key);

    /**
     * delete by ident/scope. e.g. to invalidate later on by domain class
     *
     * @param key
     * @param scopes
     */
    public void remove(final CacheKey key, final String... scopes);

    /**
     * purge the complete cache
     */
    public void purge();

    /**
     * purge a particular ident, e.g. domain scope
     */
    public void purge(final String scope);

}