GVCache.h

//
//  EGOCache.h
//  Gangverk
//
//  Created by Kevin Renskers on 30-01-2013.
//  Copyright (c) 2013 Gangverk
//
//  Permission is hereby granted, free of charge, to any person obtaining a copy
//  of this software and associated documentation files (the "Software"), to deal
//  in the Software without restriction, including without limitation the rights
//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
//  copies of the Software, and to permit persons to whom the Software is
//  furnished to do so, subject to the following conditions:
//
//  The above copyright notice and this permission notice shall be included in
//  all copies or substantial portions of the Software.
//
//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
//  THE SOFTWARE.
//

#import <Foundation/Foundation.h>


@interface GVCache : NSObject

// Global cache for easy use
+ (instancetype)globalCache;

// Opitionally create a different GVCache instance with it's own cache directory
- (id)initWithCacheDirectory:(NSString *)cacheDirectory;

- (void)clearCache;
- (void)removeCacheForKey:(NSString *)key;

- (NSTimeInterval)ageForKey:(NSString *)key;
- (BOOL)hasCacheForKey:(NSString *)key;

- (NSData *)dataForKey:(NSString *)key;
- (void)setData:(NSData *)data forKey:(NSString *)key;
- (void)setData:(NSData *)data forKey:(NSString *)key withTimeoutInterval:(NSTimeInterval)timeoutInterval;

- (NSString *)stringForKey:(NSString *)key;
- (void)setString:(NSString*)aString forKey:(NSString *)key;
- (void)setString:(NSString*)aString forKey:(NSString *)key withTimeoutInterval:(NSTimeInterval)timeoutInterval;

#if TARGET_OS_IPHONE
- (UIImage *)imageForKey:(NSString *)key;
- (void)setImage:(UIImage *)anImage forKey:(NSString *)key;
- (void)setImage:(UIImage *)anImage forKey:(NSString *)key withTimeoutInterval:(NSTimeInterval)timeoutInterval;
#else
- (NSImage*)imageForKey:(NSString *)key;
- (void)setImage:(NSImage *)anImage forKey:(NSString *)key;
- (void)setImage:(NSImage *)anImage forKey:(NSString *)key withTimeoutInterval:(NSTimeInterval)timeoutInterval;
#endif

- (NSData *)plistForKey:(NSString *)key;
- (void)setPlist:(id)plistObject forKey:(NSString *)key;
- (void)setPlist:(id)plistObject forKey:(NSString *)key withTimeoutInterval:(NSTimeInterval)timeoutInterval;

- (void)copyFilePath:(NSString *)filePath asKey:(NSString *)key;
- (void)copyFilePath:(NSString *)filePath asKey:(NSString *)key withTimeoutInterval:(NSTimeInterval)timeoutInterval;	

- (id <NSCoding>)objectForKey:(NSString *)key;
- (void)setObject:(id <NSCoding>)anObject forKey:(NSString *)key;
- (void)setObject:(id <NSCoding>)anObject forKey:(NSString *)key withTimeoutInterval:(NSTimeInterval)timeoutInterval;

@property(nonatomic, assign) NSTimeInterval defaultTimeoutInterval; // Default is 1 day

@end