kylefang/RestKit
1
0
Fork 0
mirror of https://github.com/zhigang1992/RestKit.git synced 2026-04-20 16:35:35 +08:00
Code Issues Packages Projects Releases Wiki Activity

Cleanup trailing whitespace. refs #743

Browse Source
This commit is contained in:
Blake Watters
2012-05-17 17:59:53 -04:00
parent ee30436ea6
commit fcb973056b
220 changed files with 1842 additions and 1842 deletions
Download Patch File Download Diff File Expand all files Collapse all files

96
Code/ObjectMapping/RKObjectMappingProvider.h
View File

@@ -4,13 +4,13 @@
//
// Created by Jeremy Ellison on 5/6/11.
// 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.
@@ -37,17 +37,17 @@ typedef enum {
The mapping provider is a repository of registered object mappings for use by instances
of RKObjectManager and RKObjectMapper. It provides for the storage and retrieval of object
mappings by keyPath and type.
The mapping provider is responsible for:
1. Providing instances of RKObjectMapper with keyPaths and object mappings for use
1. Providing instances of RKObjectMapper with keyPaths and object mappings for use
when attempting to map a parsed payload into objects. Each keyPath is examined using
valueForKeyPath: to determine if any mappable data exists within the payload. If data is
found, the RKObjectMapper will instantiate an RKObjectMappingOperation to perform the mapping
using the RKObjectMapping or RKDynamicObjectMapping associated with the keyPath.
1. Providing the appropriate serialization mapping to instances of RKObjectManager when an object
is to be sent to the remote server using [RKObjectManager postObject:delegate:] or
[RKObjectManager postObject:delegate]. This mapping is used to serialize the object into a
is to be sent to the remote server using [RKObjectManager postObject:delegate:] or
[RKObjectManager postObject:delegate]. This mapping is used to serialize the object into a
format suitable for encoding into a URL form encoded or JSON representation.
1. Providing convenient storage of RKObjectMapping references for users who are not using keyPath
based mapping. Mappings can be added to the provider and retrieved by the [RKObjectMapping objectClass]
@@ -59,7 +59,7 @@ typedef enum {
/**
Creates and returns an autoreleased RKObjectMappingProvider instance.
@return A new autoreleased object mapping provider instance.
*/
+ (id)mappingProvider;
@@ -73,11 +73,11 @@ typedef enum {
/**
Configures the mapping provider to use the RKObjectMapping or RKDynamicObjectMapping provided when
content is encountered at the specified keyPath.
When an RKObjectMapper is performing its work, each registered keyPath within the mapping provider will
be searched for content in the parsed payload. If mappable content is found, the object mapping configured
for the keyPath will be used to perform an RKObjectMappingOperation.
@param objectOrDynamicMapping An RKObjectMapping or RKDynamicObjectMapping to register for keyPath based mapping.
@param keyPath The keyPath to register the mapping as being responsible for mapping.
@see RKObjectMapper
@@ -86,9 +86,9 @@ typedef enum {
- (void)setObjectMapping:(RKObjectMappingDefinition *)objectOrDynamicMapping forKeyPath:(NSString *)keyPath;
/**
Returns the RKObjectMapping or RKObjectDynamic mapping configured for use
Returns the RKObjectMapping or RKObjectDynamic mapping configured for use
when mappable content is encountered at keyPath
@param keyPath A registered keyPath to retrieve the object mapping for
@return The RKObjectMapping or RKDynamicObjectMapping for the specified keyPath or nil if none is registered.
*/
@@ -97,7 +97,7 @@ typedef enum {
/**
Removes the RKObjectMapping or RKDynamicObjectMapping registered at the specified keyPath
from the provider.
@param keyPath The keyPath to remove the corresponding mapping for
*/
- (void)removeObjectMappingForKeyPath:(NSString *)keyPath;
@@ -105,7 +105,7 @@ typedef enum {
/**
Returns a dictionary where the keys are mappable keyPaths and the values are the RKObjectMapping
or RKDynamicObjectMapping to use for mappable data that appears at the keyPath.
@warning The returned dictionary can contain RKDynamicObjectMapping instances. Check the type if
you are using dynamic mapping.
@return A dictionary of all registered keyPaths and their corresponding object mapping instances
@@ -114,35 +114,35 @@ typedef enum {
/**
Registers an object mapping as being rooted at a specific keyPath. The keyPath will be registered
and an inverse mapping for the object will be generated and used for serialization.
and an inverse mapping for the object will be generated and used for serialization.
This is a shortcut for configuring a pair of object mappings that model a simple resource the same
way when going to and from the server.
For example, if we have a simple resource called 'person' that returns JSON in the following
format:
{ "person": { "first_name": "Blake", "last_name": "Watters" } }
We might configure a mapping like so:
RKObjectMapping* mapping = [RKObjectMapping mappingForClass:[Person class]];
[mapping mapAttributes:@"first_name", @"last_name", nil];
If we want to parse the above JSON and serialize it such that using postObject: or putObject: use the same format,
we can auto-generate the serialization mapping and set the whole thing up in one shot:
[[RKObjectManager sharedManager].mappingProvider registerMapping:mapping withRootKeyPath:@"person"];
This will call setMapping:forKeyPath: for you, then generate a serialization mapping and set the root
keyPath as well.
If you want to manipulate the serialization mapping yourself, you can work with the mapping directly:
RKObjectMapping* serializationMappingForPerson = [personMapping inverseMapping];
// NOTE: Serialization mapping default to a nil root keyPath and will serialize to a flat dictionary
[[RKObjectManager sharedManager].mappingProvider setSerializationMapping:serializationMappingForPerson forClass:[Person class]];
@param objectMapping An object mapping we wish to register on the provider
@param keyPath The keyPath we wish to register for the mapping and use as the rootKeyPath for serialization
*/
@@ -152,9 +152,9 @@ typedef enum {
Adds an object mapping to the provider for later retrieval. The mapping is not bound to a particular keyPath and
must be explicitly set on an instance of RKObjectLoader or RKObjectMappingOperation to be applied. This is useful
in cases where the remote system does not namespace resources in a keyPath that can be used for disambiguation.
You can retrieve mappings added to the provider by invoking objectMappingsForClass: and objectMappingForClass:
@param objectMapping An object mapping instance we wish to register with the provider.
@see objectMappingsForClass:
@see objectMappingForClass:
@@ -164,7 +164,7 @@ typedef enum {
/**
Returns all object mappings registered for a particular class on the provider. The collection of mappings is assembled
by searching for all mappings added via addObjctMapping: and then consulting those registered via objectMappingForKeyPath:
@param objectClass The class we want to retrieve the mappings for
@return An array of all object mappings matching the objectClass. Can be empty.
*/
@@ -172,16 +172,16 @@ typedef enum {
/**
Returns the first object mapping for a objectClass registered in the provider.
The objectClass is the class for a model you use to represent data retrieved in
XML or JSON format. For example, if we were developing a Twitter application we
might have an objectClass of RKTweet for storing Tweet data. We could retrieve
the object mapping for this model by invoking
the object mapping for this model by invoking
`[mappingProvider objectMappingForClass:[RKTweet class]];`
Mappings registered via addObjectMapping: take precedence over those registered
Mappings registered via addObjectMapping: take precedence over those registered
via setObjectMapping:forKeyPath:.
@param objectClass The class that we want to return mappings for
@return An RKObjectMapping matching objectClass or nil
*/
@@ -190,11 +190,11 @@ typedef enum {
/**
Registers an object mapping for use when serializing instances of objectClass for transport
over HTTP. Used by the object manager during postObject: and putObject:.
Serialization mappings are simply instances of RKObjectMapping that target NSMutableDictionary
as the target object class. After the object is mapped into an NSMutableDictionary, it can be
encoded to form encoded string, JSON, XML, etc.
@param objectMapping The serialization mapping to register for use when serializing objectClass
@param objectClass The class of the object type we are registering a serialization for
@see [RKObjectMapping serializationMapping]
@@ -203,8 +203,8 @@ typedef enum {
/**
Returns the serialization mapping for a specific object class
which has been previously registered.
which has been previously registered.
@param objectClass The class we wish to obtain the serialization mapping for
@return The RKObjectMapping instance used for mapping instances of objectClass for transport
@see setSerializationMapping:forClass:
@@ -214,16 +214,16 @@ typedef enum {
/**
Configures an object mapping to be used when during a load event where the resourcePath of
the RKObjectLoader instance matches resourcePathPattern.
The resourcePathPattern is a SOCKit pattern matching property names preceded by colons within
a path. For example, if a collection of reviews for a product were loaded from a remote system
at the resourcePath @"/products/1234/reviews", object mapping could be configured to handle
at the resourcePath @"/products/1234/reviews", object mapping could be configured to handle
this request with a resourcePathPattern of @"/products/:productID/reviews".
**NOTE** that care must be taken when configuring patterns within the provider. The patterns
will be evaluated in the order they are added to the provider, so more specific patterns must
precede more general patterns where either would generate a match.
@param objectMapping The object mapping to use when the resourcePath matches the specified
resourcePathPattern.
@param resourcePathPattern A pattern to be evaluated using an RKPathMatcher against a resourcePath
@@ -237,7 +237,7 @@ typedef enum {
/**
Returns the first objectMapping configured in the provider with a resourcePathPattern matching
the specified resourcePath.
@param resourcePath A resource path to retrieve the first RKObjectMapping or RKDynamicObjectMapping
configured with a matching pattern.
@return An RKObjectMapping or RKDynamicObjectMapping for a resource path pattern matching resourcePath
@@ -252,7 +252,7 @@ typedef enum {
/**
An object mapping used when the remote system returns an error status code
and a payload with a MIME Type that RestKit is capable of parsing.
@see RKObjectLoader
@see RKParserRegistry
*/
@@ -262,16 +262,16 @@ typedef enum {
An object mapping used when mapping pagination metadata (current page, object count, etc)
during a paginated object loading operation. The objectClass of the paginationMapping must
be RKObjectPaginator.
For example, if using the popular will_paginate plugin with Ruby on Rails, we would configure
our pagination mapping like so:
// Assumes the JSON format of http://stackoverflow.com/questions/4699182/will-paginate-json-support
RKObjectMapping *paginationMapping = [RKObjectMapping mappingForClass:[RKObjectPaginator class]];
[paginationMapping mapKeyPath:@"current_page" toAttribute:@"currentPage"];
[paginationMapping mapKeyPath:@"per_page" toAttribute:@"perPage"];
[paginationMapping mapKeyPath:@"total_entries" toAttribute:@"objectCount"];
@see RKObjectPaginator
*/
@property (nonatomic, retain) RKObjectMapping *paginationMapping;