WebObjects 5.2.3

com.webobjects.foundation
Class NSKeyValueCoding.UnknownKeyException

java.lang.Object
  extended byjava.lang.Throwable
      extended byjava.lang.Exception
          extended byjava.lang.RuntimeException
              extended bycom.webobjects.foundation.NSKeyValueCoding.UnknownKeyException
All Implemented Interfaces:
Serializable
Enclosing class:
NSKeyValueCoding

public static class NSKeyValueCoding.UnknownKeyException
extends RuntimeException

Instances of the NSKeyValueCoding.UnknownKeyException class are created and thrown when an unknown key is encountered during key-value coding.

For example, suppose an Employee object receives a valueForKey message with "partNumber" as the key. The Employee class does not declare a method or instance variable for "partNumber", so valueForKey throws an UnknownKeyException. An NSKeyValueCoding.UnknownKeyException has a user info dictionary containing entries for the object for which key-value coding failed (TargetObjectUserInfoKey) and the unknown key (UnknownUserInfoKey). For the Employee/partNumber example, the TargetObjectUserInfoKey entry would contain the Employee object and the UnknownUserInfoKey would contain the string "partNumber".

See Also:
object(), key(), NSKeyValueCoding.valueForKey(java.lang.String), NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, Serialized Form

Field Summary
static String TargetObjectUserInfoKey
          Deprecated. this user info dictionary entry should be accessed using the object method.
static String UnknownUserInfoKey
          Deprecated. this user info dictionary entry should be accessed using the key method.
 
Constructor Summary
NSKeyValueCoding.UnknownKeyException(String message, NSDictionary userInfo)
          Deprecated. Use NSKeyValueCoding.UnknownKeyException(java.lang.String, java.lang.Object, java.lang.String) instead.
NSKeyValueCoding.UnknownKeyException(String message, Object object, String key)
          Creates and returns a new UnknownKeyException with message as the message and a user info dictionary specifying object for the TargetObjectUserInfoKey and key for the UnknownUserInfoKey.
 
Method Summary
 String key()
          This method returns the key that NSKeyValueCoding operations were using at the time of the error, or null if it is unavailable.
 Object object()
          This method returns the value that NSKeyValueCoding operations were using at the time of the error, or null if it is unavailable.
 NSDictionary userInfo()
          Deprecated. The object and key methods should be used instead
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

TargetObjectUserInfoKey

public static final String TargetObjectUserInfoKey
Deprecated. this user info dictionary entry should be accessed using the object method.

See Also:
object()

UnknownUserInfoKey

public static final String UnknownUserInfoKey
Deprecated. this user info dictionary entry should be accessed using the key method.

See Also:
key()
Constructor Detail

NSKeyValueCoding.UnknownKeyException

public NSKeyValueCoding.UnknownKeyException(String message,
                                            Object object,
                                            String key)
Creates and returns a new UnknownKeyException with message as the message and a user info dictionary specifying object for the TargetObjectUserInfoKey and key for the UnknownUserInfoKey.

Parameters:
message - the message created and return
object - object specified for the TargetObjectUserInfoKey. It may be null
key - identifies the property of an object. It may be null
See Also:
object(), key()

NSKeyValueCoding.UnknownKeyException

public NSKeyValueCoding.UnknownKeyException(String message,
                                            NSDictionary userInfo)
Deprecated. Use NSKeyValueCoding.UnknownKeyException(java.lang.String, java.lang.Object, java.lang.String) instead.

Parameters:
message - A message or summary associated with the new exception
userInfo - the user info dictionary containing more information about the error
See Also:
NSKeyValueCoding.UnknownKeyException(String, Object, String), TargetObjectUserInfoKey, UnknownUserInfoKey
Method Detail

key

public String key()
This method returns the key that NSKeyValueCoding operations were using at the time of the error, or null if it is unavailable. This is equivalent to getting the UnknownUserInfoKey entry from the userInfo dictionary.

Returns:
the unknown key that caused the exception to be thrown
See Also:
UnknownUserInfoKey

object

public Object object()
This method returns the value that NSKeyValueCoding operations were using at the time of the error, or null if it is unavailable. This is equivalent to getting the TargetObjectUserInfoKey entry from the userInfo dictionary.

Returns:
the object on which key-value coding was operating when an unknown key was encountered
See Also:
TargetObjectUserInfoKey

userInfo

public NSDictionary userInfo()
Deprecated. The object and key methods should be used instead

Returns:
the userInfo dictionary associated with this exception
See Also:
object(), key()

Last updated Thu Oct 21 15:04:16 PDT 2004.

Copyright © 2004 Apple Computer, Inc.