content: /**
   * Copyright (C) 2015 Fernando Cejas Open Source Project
   *
   * 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 com.fernandocejas.android10.sample.data.cache;
  
  import com.fernandocejas.android10.sample.data.entity.UserEntity;
  import io.reactivex.Observable;
  
  /**
   * An interface representing a user Cache.
   */
  public interface UserCache {
    /**
     * Gets an {@link Observable} which will emit a {@link UserEntity}.
     *
     * @param userId The user id to retrieve data.
     */
    Observable<UserEntity> get(final int userId);
  
    /**
     * Puts and element into the cache.
     *
     * @param userEntity Element to insert in the cache.
     */
    void put(UserEntity userEntity);
  
    /**
     * Checks if an element (User) exists in the cache.
     *
     * @param userId The id used to look for inside the cache.
     * @return true if the element is cached, otherwise false.
     */
    boolean isCached(final int userId);
  
    /**
     * Checks if the cache is expired.
     *
     * @return true, the cache is expired, otherwise false.
     */
    boolean isExpired();
  
    /**
     * Evict all elements of the cache.
     */
    void evictAll();
  }
  