CannotProceedException (Java SE 11 & JDK 11 ) (original) (raw)

• • Field Summary

  Fields

  Modifier and Type	Field	Description
  protected Name	altName	Contains the name of the resolved object, relative to the context altNameCtx.
  protected Context	altNameCtx	Contains the context relative to whichaltName is specified.
  protected Hashtable	environment	Contains the environment relevant for the Context or DirContext method that cannot proceed.
  protected Name	remainingNewName	Contains the remaining unresolved part of the second "name" argument to Context.rename().

     * ### Fields declared in class javax.naming.[NamingException](NamingException.html "class in javax.naming")  
     `[remainingName](NamingException.html#remainingName), [resolvedName](NamingException.html#resolvedName), [resolvedObj](NamingException.html#resolvedObj), [rootException](NamingException.html#rootException)`  

  • Constructor Summary

  Constructors

  Constructor	Description
  CannotProceedException()	Constructs a new instance of CannotProceedException.
  CannotProceedException​(String explanation)	Constructs a new instance of CannotProceedException using an explanation.

  • Method Summary

  All Methods Instance Methods Concrete Methods

  Modifier and Type	Method	Description
  Name	getAltName()	Retrieves the altName field of this exception.
  Context	getAltNameCtx()	Retrieves the altNameCtx field of this exception.
  Hashtable	getEnvironment()	Retrieves the environment that was in effect when this exception was created.
  Name	getRemainingNewName()	Retrieves the "remaining new name" field of this exception, which is used when this exception is thrown during a rename() operation.
  void	setAltName​(Name altName)	Sets the altName field of this exception.
  void	setAltNameCtx​(Context altNameCtx)	Sets the altNameCtx field of this exception.
  void	setEnvironment​(Hashtable environment)	Sets the environment that will be returned when getEnvironment() is called.
  void	setRemainingNewName​(Name newName)	Sets the "remaining new name" field of this exception.

     * ### Methods declared in class javax.naming.[NamingException](NamingException.html "class in javax.naming")  
     `[appendRemainingComponent](NamingException.html#appendRemainingComponent%28java.lang.String%29), [appendRemainingName](NamingException.html#appendRemainingName%28javax.naming.Name%29), [getCause](NamingException.html#getCause%28%29), [getExplanation](NamingException.html#getExplanation%28%29), [getRemainingName](NamingException.html#getRemainingName%28%29), [getResolvedName](NamingException.html#getResolvedName%28%29), [getResolvedObj](NamingException.html#getResolvedObj%28%29), [getRootCause](NamingException.html#getRootCause%28%29), [initCause](NamingException.html#initCause%28java.lang.Throwable%29), [setRemainingName](NamingException.html#setRemainingName%28javax.naming.Name%29), [setResolvedName](NamingException.html#setResolvedName%28javax.naming.Name%29), [setResolvedObj](NamingException.html#setResolvedObj%28java.lang.Object%29), [setRootCause](NamingException.html#setRootCause%28java.lang.Throwable%29), [toString](NamingException.html#toString%28%29), [toString](NamingException.html#toString%28boolean%29)`  
     * ### Methods declared in class java.lang.[Throwable](../../../java.base/java/lang/Throwable.html "class in java.lang")  
     `[addSuppressed](../../../java.base/java/lang/Throwable.html#addSuppressed%28java.lang.Throwable%29), [fillInStackTrace](../../../java.base/java/lang/Throwable.html#fillInStackTrace%28%29), [getLocalizedMessage](../../../java.base/java/lang/Throwable.html#getLocalizedMessage%28%29), [getMessage](../../../java.base/java/lang/Throwable.html#getMessage%28%29), [getStackTrace](../../../java.base/java/lang/Throwable.html#getStackTrace%28%29), [getSuppressed](../../../java.base/java/lang/Throwable.html#getSuppressed%28%29), [printStackTrace](../../../java.base/java/lang/Throwable.html#printStackTrace%28%29), [printStackTrace](../../../java.base/java/lang/Throwable.html#printStackTrace%28java.io.PrintStream%29), [printStackTrace](../../../java.base/java/lang/Throwable.html#printStackTrace%28java.io.PrintWriter%29), [setStackTrace](../../../java.base/java/lang/Throwable.html#setStackTrace%28java.lang.StackTraceElement%5B%5D%29)`  
     * ### Methods declared in class java.lang.[Object](../../../java.base/java/lang/Object.html "class in java.lang")  
     `[clone](../../../java.base/java/lang/Object.html#clone%28%29), [equals](../../../java.base/java/lang/Object.html#equals%28java.lang.Object%29), [finalize](../../../java.base/java/lang/Object.html#finalize%28%29), [getClass](../../../java.base/java/lang/Object.html#getClass%28%29), [hashCode](../../../java.base/java/lang/Object.html#hashCode%28%29), [notify](../../../java.base/java/lang/Object.html#notify%28%29), [notifyAll](../../../java.base/java/lang/Object.html#notifyAll%28%29), [wait](../../../java.base/java/lang/Object.html#wait%28%29), [wait](../../../java.base/java/lang/Object.html#wait%28long%29), [wait](../../../java.base/java/lang/Object.html#wait%28long,int%29)`

• • Field Detail

     * #### remainingNewName  
     protected [Name](Name.html "interface in javax.naming") remainingNewName  
     Contains the remaining unresolved part of the second "name" argument to Context.rename(). This information is necessary for continuing the Context.rename() operation.  
      This field is initialized to null. It should not be manipulated directly: it should be accessed and updated using getRemainingName() and setRemainingName().  
     See Also:  
     [getRemainingNewName()](#getRemainingNewName%28%29), [setRemainingNewName(javax.naming.Name)](#setRemainingNewName%28javax.naming.Name%29)  
     * #### environment  
     protected [Hashtable](../../../java.base/java/util/Hashtable.html "class in java.util")<?,​?> environment  
     Contains the environment relevant for the Context or DirContext method that cannot proceed.  
      This field is initialized to null. It should not be manipulated directly: it should be accessed and updated using getEnvironment() and setEnvironment().  
     See Also:  
     [getEnvironment()](#getEnvironment%28%29), [setEnvironment(java.util.Hashtable<?, ?>)](#setEnvironment%28java.util.Hashtable%29)  
     * #### altName  
     protected [Name](Name.html "interface in javax.naming") altName  
     Contains the name of the resolved object, relative to the context `altNameCtx`. It is a composite name. If null, then no name is specified. See the `javax.naming.spi.ObjectFactory.getObjectInstance` method for details on how this is used.  
      This field is initialized to null. It should not be manipulated directly: it should be accessed and updated using getAltName() and setAltName().  
     See Also:  
     [getAltName()](#getAltName%28%29), [setAltName(javax.naming.Name)](#setAltName%28javax.naming.Name%29), [altNameCtx](#altNameCtx), [ObjectFactory.getObjectInstance(java.lang.Object, javax.naming.Name, javax.naming.Context, java.util.Hashtable<?, ?>)](spi/ObjectFactory.html#getObjectInstance%28java.lang.Object,javax.naming.Name,javax.naming.Context,java.util.Hashtable%29)  
     * #### altNameCtx  
     protected [Context](Context.html "interface in javax.naming") altNameCtx  
     Contains the context relative to which`altName` is specified. If null, then the default initial context is implied. See the `javax.naming.spi.ObjectFactory.getObjectInstance` method for details on how this is used.  
      This field is initialized to null. It should not be manipulated directly: it should be accessed and updated using getAltNameCtx() and setAltNameCtx().  
     See Also:  
     [getAltNameCtx()](#getAltNameCtx%28%29), [setAltNameCtx(javax.naming.Context)](#setAltNameCtx%28javax.naming.Context%29), [altName](#altName), [ObjectFactory.getObjectInstance(java.lang.Object, javax.naming.Name, javax.naming.Context, java.util.Hashtable<?, ?>)](spi/ObjectFactory.html#getObjectInstance%28java.lang.Object,javax.naming.Name,javax.naming.Context,java.util.Hashtable%29)  

  • Constructor Detail

    * #### CannotProceedException  
    public CannotProceedException​([String](../../../java.base/java/lang/String.html "class in java.lang") explanation)  
    Constructs a new instance of CannotProceedException using an explanation. All unspecified fields default to null.  
    Parameters:  
    `explanation` \- A possibly null string containing additional detail about this exception. If null, this exception has no detail message.  
    See Also:  
    [Throwable.getMessage()](../../../java.base/java/lang/Throwable.html#getMessage%28%29)  
    * #### CannotProceedException  
    public CannotProceedException()  
    Constructs a new instance of CannotProceedException. All fields default to null.  

  • Method Detail

    * #### getEnvironment  
    public [Hashtable](../../../java.base/java/util/Hashtable.html "class in java.util")<?,​?> getEnvironment()  
    Retrieves the environment that was in effect when this exception was created.  
    Returns:  
    Possibly null environment property set. null means no environment was recorded for this exception.  
    See Also:  
    [setEnvironment(java.util.Hashtable<?, ?>)](#setEnvironment%28java.util.Hashtable%29)  
    * #### setEnvironment  
    public void setEnvironment​([Hashtable](../../../java.base/java/util/Hashtable.html "class in java.util")<?,​?> environment)  
    Sets the environment that will be returned when getEnvironment() is called.  
    Parameters:  
    `environment` \- A possibly null environment property set. null means no environment is being recorded for this exception.  
    See Also:  
    [getEnvironment()](#getEnvironment%28%29)  
    * #### getRemainingNewName  
    public [Name](Name.html "interface in javax.naming") getRemainingNewName()  
    Retrieves the "remaining new name" field of this exception, which is used when this exception is thrown during a rename() operation.  
    Returns:  
    The possibly null part of the new name that has not been resolved. It is a composite name. It can be null, which means the remaining new name field has not been set.  
    See Also:  
    [setRemainingNewName(javax.naming.Name)](#setRemainingNewName%28javax.naming.Name%29)  
    * #### setRemainingNewName  
    public void setRemainingNewName​([Name](Name.html "interface in javax.naming") newName)  
    Sets the "remaining new name" field of this exception. This is the value returned by `getRemainingNewName()`.  
    `newName` is a composite name. If the intent is to set this field using a compound name or string, you must "stringify" the compound name, and create a composite name with a single component using the string. You can then invoke this method using the resulting composite name.  
     A copy of `newName` is made and stored. Subsequent changes to `name` does not affect the copy in this NamingException and vice versa.  
    Parameters:  
    `newName` \- The possibly null name to set the "remaining new name" to. If null, it sets the remaining name field to null.  
    See Also:  
    [getRemainingNewName()](#getRemainingNewName%28%29)  
    * #### getAltName  
    public [Name](Name.html "interface in javax.naming") getAltName()  
    Retrieves the `altName` field of this exception. This is the name of the resolved object, relative to the context`altNameCtx`. It will be used during a subsequent call to the`javax.naming.spi.ObjectFactory.getObjectInstance` method.  
    Returns:  
    The name of the resolved object, relative to`altNameCtx`. It is a composite name. If null, then no name is specified.  
    See Also:  
    [setAltName(javax.naming.Name)](#setAltName%28javax.naming.Name%29), [getAltNameCtx()](#getAltNameCtx%28%29), [ObjectFactory.getObjectInstance(java.lang.Object, javax.naming.Name, javax.naming.Context, java.util.Hashtable<?, ?>)](spi/ObjectFactory.html#getObjectInstance%28java.lang.Object,javax.naming.Name,javax.naming.Context,java.util.Hashtable%29)  
    * #### setAltName  
    public void setAltName​([Name](Name.html "interface in javax.naming") altName)  
    Sets the `altName` field of this exception.  
    Parameters:  
    `altName` \- The name of the resolved object, relative to`altNameCtx`. It is a composite name. If null, then no name is specified.  
    See Also:  
    [getAltName()](#getAltName%28%29), [setAltNameCtx(javax.naming.Context)](#setAltNameCtx%28javax.naming.Context%29)  
    * #### getAltNameCtx  
    public [Context](Context.html "interface in javax.naming") getAltNameCtx()  
    Retrieves the `altNameCtx` field of this exception. This is the context relative to which `altName` is named. It will be used during a subsequent call to the`javax.naming.spi.ObjectFactory.getObjectInstance` method.  
    Returns:  
    The context relative to which `altName` is named. If null, then the default initial context is implied.  
    See Also:  
    [setAltNameCtx(javax.naming.Context)](#setAltNameCtx%28javax.naming.Context%29), [getAltName()](#getAltName%28%29), [ObjectFactory.getObjectInstance(java.lang.Object, javax.naming.Name, javax.naming.Context, java.util.Hashtable<?, ?>)](spi/ObjectFactory.html#getObjectInstance%28java.lang.Object,javax.naming.Name,javax.naming.Context,java.util.Hashtable%29)  
    * #### setAltNameCtx  
    public void setAltNameCtx​([Context](Context.html "interface in javax.naming") altNameCtx)  
    Sets the `altNameCtx` field of this exception.  
    Parameters:  
    `altNameCtx` \- The context relative to which `altName` is named. If null, then the default initial context is implied.  
    See Also:  
    [getAltNameCtx()](#getAltNameCtx%28%29), [setAltName(javax.naming.Name)](#setAltName%28javax.naming.Name%29)