Up

NSCoder class reference

Authors

Andrew Kachites McCallum (mccallum@gnu.ai.mit.edu)
Adam Fedor (fedor@boulder.colorado.edu)

Version: 1.40

Date: 2004/01/25 18:39:20

Copyright: (C) 1995, 1996 Free Software Foundation, Inc.


Contents -

  1. Software documentation for the NSCoder class
  2. Software documentation for the NSCoder(GNUstep) category

Software documentation for the NSCoder class

NSCoder : NSObject

Declared in:
Foundation/NSCoder.h
Standards:

Description forthcoming.

Method summary

allowsKeyedCoding 

- (BOOL) allowsKeyedCoding;
Subclasses should override this method.

Returns a flag indicating whether the receiver supported keyed coding. the default implementation returns NO. Subclasses supporting keyed coding must override this to return YES.


containsValueForKey: 

- (BOOL) containsValueForKey: (NSString*)aKey;
Subclasses should override this method.

Returns a class indicating whether an encoded value corresponding to aKey exists.


decodeArrayOfObjCType: count: at: 

- (void) decodeArrayOfObjCType: (const char*)type count: (unsigned)count at: (void*)address;

Description forthcoming.


decodeBoolForKey: 

- (BOOL) decodeBoolForKey: (NSString*)aKey;
Subclasses should override this method.

Returns a boolean value associated with aKey. This value must previously have been encoded using -encodeBool:forKey:


decodeBytesForKey: returnedLength: 

- (const uint8_t*) decodeBytesForKey: (NSString*)aKey returnedLength: (unsigned*)alength;
Subclasses should override this method.

Returns a pointer to a byte array associated with aKey.
Returns the length of the data in aLength.
This value must previously have been encoded using -encodeBytes:length:forKey:


decodeBytesWithReturnedLength: 

- (void*) decodeBytesWithReturnedLength: (unsigned*)l;

Description forthcoming.


decodeDataObject 

- (NSData*) decodeDataObject;

Description forthcoming.


decodeDoubleForKey: 

- (double) decodeDoubleForKey: (NSString*)aKey;
Subclasses should override this method.

Returns a double value associated with aKey. This value must previously have been encoded using -encodeDouble:forKey: or -encodeFloat:forKey:


decodeFloatForKey: 

- (float) decodeFloatForKey: (NSString*)aKey;
Subclasses should override this method.

Returns a float value associated with aKey. This value must previously have been encoded using -encodeFloat:forKey: or -encodeDouble:forKey:
Precision may be lost (or an exception raised if the value will not fit in a float) if the value was encoded using -encodeDouble:forKey: ,


decodeInt32ForKey: 

- (int32_t) decodeInt32ForKey: (NSString*)aKey;
Subclasses should override this method.

Returns a 32-bit integer value associated with aKey. This value must previously have been encoded using -encodeInt:forKey: , -encodeInt32:forKey: , or -encodeInt64:forKey: .
An exception will be raised if the value does not fit in a 32-bit integer.


decodeInt64ForKey: 

- (int64_t) decodeInt64ForKey: (NSString*)aKey;
Subclasses should override this method.

Returns a 64-bit integer value associated with aKey. This value must previously have been encoded using -encodeInt:forKey: , -encodeInt32:forKey: , or -encodeInt64:forKey: .


decodeIntForKey: 

- (int) decodeIntForKey: (NSString*)aKey;
Subclasses should override this method.

Returns an integer value associated with aKey. This value must previously have been encoded using -encodeInt:forKey: , -encodeInt32:forKey: , or -encodeInt64:forKey: .
An exception will be raised if the value does not fit in an integer.


decodeObject 

- (id) decodeObject;

Description forthcoming.


decodeObjectForKey: 

- (id) decodeObjectForKey: (NSString*)aKey;
Subclasses should override this method.

Returns an object value associated with aKey. This value must previously have been encoded using -encodeObject:forKey: or -encodeConditionalObject:forKey:


decodePoint 

- (NSPoint) decodePoint;

Description forthcoming.


decodePropertyList 

- (id) decodePropertyList;

Description forthcoming.


decodeRect 

- (NSRect) decodeRect;

Description forthcoming.


decodeSize 

- (NSSize) decodeSize;

Description forthcoming.


decodeValueOfObjCType: at: 

- (void) decodeValueOfObjCType: (const char*)type at: (void*)address;

Description forthcoming.


decodeValuesOfObjCTypes: ,...

- (void) decodeValuesOfObjCTypes: (const char*)types,...;

Description forthcoming.


encodeArrayOfObjCType: count: at: 

- (void) encodeArrayOfObjCType: (const char*)type count: (unsigned)count at: (const void*)array;

Description forthcoming.


encodeBool: forKey: 

- (void) encodeBool: (BOOL)aBool forKey: (NSString*)aKey;
Subclasses should override this method.

Encodes aBool and associates the encoded value with aKey.


encodeBycopyObject: 

- (void) encodeBycopyObject: (id)anObject;

Description forthcoming.


encodeByrefObject: 

- (void) encodeByrefObject: (id)anObject;

Description forthcoming.


encodeBytes: length: 

- (void) encodeBytes: (void*)d length: (unsigned)l;

Description forthcoming.


encodeBytes: length: forKey: 

- (void) encodeBytes: (const uint8_t*)aPointer length: (unsigned)length forKey: (NSString*)aKey;
Subclasses should override this method.

Encodes the data of the specified length and pointed to by aPointeraBool, and associates the encoded value with aKey.


encodeConditionalObject: 

- (void) encodeConditionalObject: (id)anObject;

Description forthcoming.


encodeConditionalObject: forKey: 

- (void) encodeConditionalObject: (id)anObject forKey: (NSString*)aKey;
Subclasses should override this method.

Encodes anObject and associates the encoded value with aKey, but only if anObject has already been encoded using -encodeObject:forKey:


encodeDataObject: 

- (void) encodeDataObject: (NSData*)data;

Description forthcoming.


encodeDouble: forKey: 

- (void) encodeDouble: (double)aDouble forKey: (NSString*)aKey;
Subclasses should override this method.

Encodes aDouble and associates the encoded value with aKey.


encodeFloat: forKey: 

- (void) encodeFloat: (float)aFloat forKey: (NSString*)aKey;
Subclasses should override this method.

Encodes aFloat and associates the encoded value with aKey.


encodeInt32: forKey: 

- (void) encodeInt32: (int32_t)anInteger forKey: (NSString*)aKey;
Subclasses should override this method.

Encodes anInteger and associates the encoded value with aKey.


encodeInt64: forKey: 

- (void) encodeInt64: (int64_t)anInteger forKey: (NSString*)aKey;
Subclasses should override this method.

Encodes anInteger and associates the encoded value with aKey.


encodeInt: forKey: 

- (void) encodeInt: (int)anInteger forKey: (NSString*)aKey;
Subclasses should override this method.

Encodes anInteger and associates the encoded value with aKey.


encodeObject: 

- (void) encodeObject: (id)anObject;

Description forthcoming.


encodeObject: forKey: 

- (void) encodeObject: (id)anObject forKey: (NSString*)aKey;
Subclasses should override this method.

Encodes anObject and associates the encoded value with aKey.


encodePoint: 

- (void) encodePoint: (NSPoint)point;

Description forthcoming.


encodePropertyList: 

- (void) encodePropertyList: (id)plist;

Description forthcoming.


encodeRect: 

- (void) encodeRect: (NSRect)rect;

Description forthcoming.


encodeRootObject: 

- (void) encodeRootObject: (id)rootObject;

Description forthcoming.


encodeSize: 

- (void) encodeSize: (NSSize)size;

Description forthcoming.


encodeValueOfObjCType: at: 

- (void) encodeValueOfObjCType: (const char*)type at: (const void*)address;

Description forthcoming.


encodeValuesOfObjCTypes: ,...

- (void) encodeValuesOfObjCTypes: (const char*)types,...;

Description forthcoming.


objectZone 

- (NSZone*) objectZone;

Description forthcoming.


setObjectZone: 

- (void) setObjectZone: (NSZone*)zone;

Description forthcoming.


systemVersion 

- (unsigned int) systemVersion;

Description forthcoming.


versionForClassName: 

- (unsigned int) versionForClassName: (NSString*)className;

Description forthcoming.


Software documentation for the NSCoder(GNUstep) category

NSCoder(GNUstep)

Declared in:
Foundation/NSCoder.h
Standards:

Description forthcoming.

Method summary

decodeArrayOfObjCType: count: at: withName: 

- (void) decodeArrayOfObjCType: (const char*)type count: (unsigned)count at: (void*)buf withName: (id*)name;

Description forthcoming.


decodeIndent 

- (void) decodeIndent;

Description forthcoming.


decodeObjectAt: withName: 

- (void) decodeObjectAt: (id*)anObject withName: (id*)name;

Description forthcoming.


decodeValueOfCType: at: withName: 

- (void) decodeValueOfCType: (const char*)type at: (void*)buf withName: (id*)name;

Description forthcoming.


decodeValueOfObjCType: at: withName: 

- (void) decodeValueOfObjCType: (const char*)type at: (void*)buf withName: (id*)name;

Description forthcoming.


encodeArrayOfObjCType: count: at: withName: 

- (void) encodeArrayOfObjCType: (const char*)type count: (unsigned)count at: (const void*)buf withName: (id)name;

Description forthcoming.


encodeIndent 

- (void) encodeIndent;

Description forthcoming.


encodeObjectAt: withName: 

- (void) encodeObjectAt: (id*)anObject withName: (id)name;

Description forthcoming.


encodeValueOfCType: at: withName: 

- (void) encodeValueOfCType: (const char*)type at: (const void*)buf withName: (id)name;

Description forthcoming.


encodeValueOfObjCType: at: withName: 

- (void) encodeValueOfObjCType: (const char*)type at: (const void*)buf withName: (id)name;

Description forthcoming.



Up