mirror of
https://github.com/zhigang1992/RestKit.git
synced 2026-04-21 02:50:11 +08:00
Overhaul RKParser API's for clarity and simplicity:
* Adds support for NSJSONSerialization. closes #476 * Renames RKParser to RKSerialization * Renames RKParserRegistry to RKMIMETypeSerialization * Rework serialization implementations API's to use class methods * Fold together string and regular expression matching for MIME Type registrations * Port serialization implementations to working off of NSData instead of NSString. refs #762 * Migrate JSONKit to being an optional component. See https://github.com/RestKit/RKJSONKitSerialization
This commit is contained in:
52
Code/Support/RKSerialization.h
Normal file
52
Code/Support/RKSerialization.h
Normal file
@@ -0,0 +1,52 @@
|
||||
//
|
||||
// RKCoding.h
|
||||
// RestKit
|
||||
//
|
||||
// Created by Blake Watters on 10/1/10.
|
||||
// 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.
|
||||
//
|
||||
|
||||
/**
|
||||
The RKSerialization protocol declares two methods that a class must implement
|
||||
so that it can provide support for serializing objects to and deserializing objects
|
||||
from UTF-8 encoded data representations of a serialization format such as JSON
|
||||
or XML. Serialization implementations typically handle data in a given MIME Type
|
||||
(i.e. application/json) and may be registered with the RKCoder class.
|
||||
|
||||
@see RKMIMETypeSerialization
|
||||
*/
|
||||
@protocol RKSerialization <NSObject>
|
||||
|
||||
/**
|
||||
Deserializes and returns the given data in the format supported by the receiver
|
||||
(i.e. JSON, XML, etc) as a Foundation object representation.
|
||||
|
||||
@param data The UTF-8 encoded data representation of the object to be deserialized.
|
||||
@param error A pointer to an NSError object.
|
||||
@return A Foundation object from the serialized data in data, or nil if an error occurs.
|
||||
*/
|
||||
+ (id)objectFromData:(NSData *)data error:(NSError **)error;
|
||||
|
||||
/**
|
||||
Serializes and returns a UTF-8 encoded data representation of the given Foundation
|
||||
object in the format supported by the receiver (i.e. JSON, XML, etc).
|
||||
|
||||
@param object The object to be serialized.
|
||||
@param A pointer to an NSError object.
|
||||
@return A data representation of the given object in UTF-8 encoding, or nil if an error occurred.
|
||||
*/
|
||||
+ (NSData *)dataFromObject:(id)object error:(NSError **)error;
|
||||
|
||||
@end
|
||||
Reference in New Issue
Block a user