mirror of
https://github.com/zhigang1992/RestKit.git
synced 2026-04-02 09:31:32 +08:00
95 lines
4.1 KiB
Objective-C
95 lines
4.1 KiB
Objective-C
//
|
|
// NSBundle+RKAdditions.h
|
|
// RestKit
|
|
//
|
|
// Created by Blake Watters on 2/1/12.
|
|
// Copyright (c) 2009-2012 RestKit. All rights reserved.
|
|
//
|
|
// 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.
|
|
//
|
|
|
|
#import <Foundation/Foundation.h>
|
|
|
|
#if TARGET_OS_IPHONE
|
|
#import <UIKit/UIImage.h>
|
|
#endif
|
|
|
|
/**
|
|
Provides convenience methods for accessing data in resources
|
|
within an NSBundle.
|
|
*/
|
|
@interface NSBundle (RKAdditions)
|
|
|
|
/**
|
|
Returns an NSBundle reference to the RestKitResources.bundle file containing
|
|
RestKit specific resource assets.
|
|
|
|
This method is a convenience wrapper for invoking
|
|
`[NSBundle bundleWithIdentifier:@"org.restkit.RestKitResources"]`
|
|
|
|
@return An NSBundle object corresponding to the RestKitResources.bundle file.
|
|
*/
|
|
+ (NSBundle *)restKitResourcesBundle;
|
|
|
|
/**
|
|
Returns the MIME Type for the resource identified by the specified name and file extension.
|
|
|
|
@param name The name of the resource file.
|
|
@param extension If extension is an empty string or nil, the extension is assumed not to exist and the file is the first file encountered that exactly matches name.
|
|
@return The MIME Type for the resource file or nil if the file could not be located.
|
|
*/
|
|
- (NSString *)MIMETypeForResource:(NSString *)name withExtension:(NSString *)extension;
|
|
|
|
/**
|
|
Creates and returns a data object by reading every byte from the resource identified by the specified name and file extension.
|
|
|
|
@param name The name of the resource file.
|
|
@param extension If extension is an empty string or nil, the extension is assumed not to exist and the file is the first file encountered that exactly matches name.
|
|
@return A data object by reading every byte from the resource file.
|
|
*/
|
|
- (NSData *)dataWithContentsOfResource:(NSString *)name withExtension:(NSString *)extension;
|
|
|
|
/**
|
|
Creates and returns a string object by reading data from the resource identified by the specified name and file extension using a given encoding.
|
|
|
|
@param name The name of the resource file.
|
|
@param extension If extension is an empty string or nil, the extension is assumed not to exist and the file is the first file encountered that exactly matches name.
|
|
@param encoding The encoding of the resource file.
|
|
@return A string created by reading data from the resource file using the encoding.
|
|
*/
|
|
- (NSString *)stringWithContentsOfResource:(NSString *)name withExtension:(NSString *)extension encoding:(NSStringEncoding)encoding;
|
|
|
|
#if TARGET_OS_IPHONE
|
|
/**
|
|
Creates and returns an image object by loading the image data from the resource identified by the specified name and file extension.
|
|
|
|
@param name The name of the resource file.
|
|
@param extension If extension is an empty string or nil, the extension is assumed not to exist and the file is the first file encountered that exactly matches name.
|
|
@return A new image object for the specified file, or nil if the method could not initialize the image from the specified file.
|
|
*/
|
|
- (UIImage *)imageWithContentsOfResource:(NSString *)name withExtension:(NSString *)extension;
|
|
#endif
|
|
|
|
/**
|
|
Creates and returns an object representation of the data from the resource identified by the specified name and file extension by reading the
|
|
data as a string and parsing it using a parser appropriate for the MIME Type of the file.
|
|
|
|
@param name The name of the resource file.
|
|
@param extension If extension is an empty string or nil, the extension is assumed not to exist and the file is the first file encountered that exactly matches name.
|
|
@return A new image object for the specified file, or nil if the method could not initialize the image from the specified file.
|
|
@see RKParserRegistry
|
|
*/
|
|
- (id)parsedObjectWithContentsOfResource:(NSString *)name withExtension:(NSString *)extension;
|
|
|
|
@end
|