Spec-Zone.ru › OpenJDK 17

Класс NamingException

java.lang.Object
java.lang.Throwable
java.lang.Exception
javax.naming.NamingException
Все реализуемые интерфейсы:
Serializable
Прямые известные подклассы:
AttributeInUseException, AttributeModificationException, CannotProceedException, CommunicationException, ConfigurationException, ContextNotEmptyException, InsufficientResourcesException, InterruptedNamingException, InvalidAttributeIdentifierException, InvalidAttributesException, InvalidAttributeValueException, InvalidNameException, InvalidSearchControlsException, InvalidSearchFilterException, LimitExceededException, LinkException, NameAlreadyBoundException, NameNotFoundException, NamingSecurityException, NoInitialContextException, NoSuchAttributeException, NotContextException, OperationNotSupportedException, PartialResultException, ReferralException, SchemaViolationException, ServiceUnavailableException 
public class NamingException extends Exception
Этот класс является суперклассом для всех исключений, выбрасываемых операциями в интерфейсах Context и DirContext. Характер сбоя описывается именем подкласса. Это исключение содержит информацию, точно определяющую, где произошла операция, например, до какого места дошла разрешающая операция.
  • Разрешенное имя. Часть имени, которая была разрешена.
  • Разрешенный объект. Объект, до которого дошла разрешающая операция имени.
  • Остаток имени. Часть имени, которая не была разрешена.
  • Объяснение. Подробное объяснение причины сбоя разрешения имени.
  • Корневое исключение. Исключение, которое вызвало это исключение NamingException.
null является допустимым значением для любого из этих полей. При значении null это означает, что для данного поля не было записано никакой информации.

Экземпляр NamingException не синхронизирован для одновременного доступа в многопоточных приложениях. Несколько потоков, пытающихся получить доступ и изменить один экземпляр NamingException, должны заблокировать объект.

Это исключение было адаптировано для соответствия общему механизму обработки исключений с цепочкой вызовов. Корневое исключение (или причина) — это тот же самый объект, что и причина, возвращаемая методом Throwable.getCause().

Since:
1.3
См. также:
  • Сериализованная форма

Краткое описание полей

Модификатор и тип Поле Описание
protected Name remainingName
Содержит оставшееся имя, которое еще не было разрешено.
protected Name resolvedName
Содержит часть имени, которая была успешно разрешена.
protected Object resolvedObj
Содержит объект, до которого было успешно разрешено имя.
protected Throwable rootException
Содержит исходное исключение, которое вызвало это исключение NamingException.

Краткое описание конструкторов

Конструктор Описание
NamingException()
Создает новое исключение NamingException.
NamingException(String explanation)
Создает новое исключение NamingException с пояснением.

Краткое описание методов

Модификатор и тип Метод Описание
void appendRemainingComponent(String name)
Добавляет имя в качестве последнего компонента в оставшееся имя.
void appendRemainingName(Name name)
Добавляет компоненты из 'name' в качестве последних компонентов в оставшееся имя.
Throwable getCause()
Возвращает причину этого исключения.
String getExplanation()
Возвращает пояснение, связанное с этим исключением.
Name getRemainingName()
Возвращает оставшуюся неразрешенную часть имени.
Name getResolvedName()
Возвращает ведущую часть имени, которая была успешно разрешена.
Object getResolvedObj()
Возвращает объект, до которого было выполнено разрешение.
Throwable getRootCause()
Возвращает корневую причину этого исключения NamingException, если таковая имеется.
Throwable initCause(Throwable cause)
Инициализирует причину этого исключения заданным значением.
void setRemainingName(Name name)
Устанавливает поле оставшегося имени для этого исключения.
void setResolvedName(Name name)
Устанавливает поле разрешенного имени для этого исключения.
void setResolvedObj(Object obj)
Устанавливает поле разрешенного объекта для этого исключения.
void setRootCause(Throwable e)
Записывает корневую причину этого исключения NamingException.
String toString()
Генерирует строковое представление этого исключения.
String toString(boolean detail)
Генерирует строковое представление с более подробной информацией.

Методы, объявленные в классе java.lang.Throwable

addSuppressed, fillInStackTrace, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Методы, объявленные в классе java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Подробное описание полей

resolvedName

protected Name resolvedName
Содержит часть имени, которая была успешно разрешена. Это составное имя и может быть null. Это поле инициализируется конструкторами. Доступ к этому полю и манипуляции с ним следует осуществлять через методы get и set.
См. также:
  • getResolvedName()
  • setResolvedName(javax.naming.Name)

resolvedObj

protected Object resolvedObj
Содержит объект, для которого разрешение части имени было успешным. Может быть null. Это поле инициализируется конструкторами. Доступ к этому полю и манипуляции с ним следует осуществлять через методы get и set.
См. также:
  • getResolvedObj()
  • setResolvedObj(java.lang.Object)

remainingName

protected Name remainingName
Содержит оставшуюся часть имени, которая ещё не была разрешена. Это составное имя и может быть null. Это поле инициализируется конструкторами. Доступ к этому полю и манипуляции с ним следует осуществлять через методы get, set, «append».
См. также:
  • getRemainingName()
  • setRemainingName(javax.naming.Name)
  • appendRemainingName(javax.naming.Name)
  • appendRemainingComponent(java.lang.String)

rootException

protected Throwable rootException
Содержит исходное исключение, которое привело к возникновению этого исключения NamingException. Это поле устанавливается, если есть дополнительная информация, которая может быть получена из исходного исключения, или если исходное исключение не может быть сопоставлено с подклассом NamingException. Может быть null.

Это поле предшествует общедоступному механизму цепочки исключений. Методы initCause(Throwable) и getCause() теперь предпочтительны для доступа к этой информации.

См. также:
  • getRootCause()
  • setRootCause(Throwable)
  • initCause(Throwable)
  • getCause()

Подробное описание конструкторов

NamingException

public NamingException(String explanation)
Создаёт новое исключение NamingException с объяснением. Все поля, которые не заданы, устанавливаются в null.
Параметры:
explanation - Возможно null строка, содержащая дополнительные детали об этом исключении.
См. также:
  • Throwable.getMessage()

NamingException

public NamingException()
Создаёт новое исключение NamingException. Все поля устанавливаются в null.

Подробное описание методов

getResolvedName

public Name getResolvedName()
Извлекает ведущую часть имени, которая была успешно разрешена.
Возвращает:
Часть имени, которая была успешно разрешена. Это составное имя. Может быть null, что означает, что поле resolvedName не было установлено.
См. также:
  • getResolvedObj()
  • setResolvedName(javax.naming.Name)

getRemainingName

public Name getRemainingName()
Извлекает оставшуюся неразрешённую часть имени.
Возвращает:
Часть имени, которая не была разрешена. Это составное имя. Может быть null, что означает, что поле remainingName не было установлено.
См. также:
  • setRemainingName(javax.naming.Name)
  • appendRemainingName(javax.naming.Name)
  • appendRemainingComponent(java.lang.String)

getResolvedObj

public Object getResolvedObj()
Извлекает объект, для которого разрешение было успешным. Это объект, к которому привязано разрешенное имя.
Возвращает:
Возможный null-объект, который был разрешён до сих пор. null означает, что поле resolved object не было установлено.
См. также:
  • getResolvedName()
  • setResolvedObj(java.lang.Object)

getExplanation

public String getExplanation()
Извлекает объяснение, связанное с этим исключением.
Возвращает:
Возможная null-строка, содержащая подробное объяснение этого исключения. Если null, это означает, что для этого исключения нет сообщения об ошибке.
См. также:
  • Throwable.getMessage()

setResolvedName

public void setResolvedName(Name name)
Устанавливает поле resolved name этого исключения.

name — это составное имя. Если цель состоит в установке этого поля с использованием составного имени или строки, вы должны «преобразовать» составное имя в строку и создать составное имя с одним компонентом, используя строку. Затем вы можете вызвать этот метод, используя полученное составное имя.

Создаётся и сохраняется копия name. Последующие изменения name не влияют на копию в этом исключении NamingException и наоборот.

Параметры:
name - Возможно null имя, для которого будет установлено поле resolved name. Если null, то поле resolved name устанавливается в null.
См. также:
  • getResolvedName()

setRemainingName

public void setRemainingName(Name name)
Устанавливает поле remaining name этого исключения.

name — это составное имя. Если цель состоит в установке этого поля с использованием составного имени или строки, вы должны «преобразовать» составное имя в строку и создать составное имя с одним компонентом, используя строку. Затем вы можете вызвать этот метод, используя полученное составное имя.

Создаётся и сохраняется копия name. Последующие изменения name не влияют на копию в этом исключении NamingException и наоборот.

Параметры:
name - Возможно null имя, для которого будет установлено поле remaining name. Если null, то поле remaining name устанавливается в null.
См. также:
  • getRemainingName()
  • appendRemainingName(javax.naming.Name)
  • appendRemainingComponent(java.lang.String)

setResolvedObj

public void setResolvedObj(Object obj)
Устанавливает поле resolved object этого исключения.
Параметры:
obj - Возможно null объект, для которого будет установлено поле resolved object. Если null, то поле resolved object устанавливается в null.
См. также:
  • getResolvedObj()

appendRemainingComponent

public void appendRemainingComponent(String name)
Добавляет имя в качестве последнего компонента в оставшееся имя.
Параметры:
name - Компонент для добавления. Если имя null, этот метод ничего не делает.
См. также:
  • setRemainingName(javax.naming.Name)
  • getRemainingName()
  • appendRemainingName(javax.naming.Name)

appendRemainingName

public void appendRemainingName(Name name)
Добавляет компоненты из 'name' в качестве последних компонентов в оставшееся имя.

name — это составное имя. Если целью является добавление составного имени, вы должны преобразовать составное имя в строку, а затем вызвать перегруженный вариант, принимающий строковый параметр.

Последующие изменения name не влияют на поле оставшегося имени в этом исключении NamingException и наоборот.

Параметры:
name - Возможно null имя, содержащее упорядоченные компоненты для добавления. Если имя null, этот метод ничего не делает.
См. также:
  • setRemainingName(javax.naming.Name)
  • getRemainingName()
  • appendRemainingComponent(java.lang.String)

getRootCause

public Throwable getRootCause()
Извлекает причину исключения NamingException, если таковая имеется. Причина исключения используется поставщиком сервиса, чтобы указать вызывающей стороне об ошибке, не связанной с именованием, но при этом использовать структуру NamingException, чтобы показать, насколько продвинулась операция именования.

Этот метод предшествует общей функции цепочки исключений. Сейчас метод getCause() предпочтительнее для получения этой информации.

Возвращает:
Возможная исключительная ситуация, которая вызвала это исключение именования (может быть null). Если null, это означает, что для этого исключения именования не задана причина.
См. также:
  • setRootCause(java.lang.Throwable)
  • rootException
  • getCause()

setRootCause

public void setRootCause(Throwable e)
Записывает причину исключения NamingException. Если e равно this, этот метод ничего не делает.

Этот метод предшествует общей функции цепочки исключений. Сейчас метод initCause(Throwable) предпочтительнее для записи этой информации.

Параметры:
e - Возможное исключение (может быть null), вызвавшее сбой операции именования. Если null, это означает, что для этого исключения именования нет причины.
См. также:
  • getRootCause()
  • rootException
  • initCause(java.lang.Throwable)

getCause

public Throwable getCause()
Возвращает причину этого исключения. Причина — исключительная ситуация, которая привела к выбрасыванию этого исключения именования. Возвращает null , если причина отсутствует или неизвестна.
Переопределяет:
getCause в классе Throwable
Возвращает:
причина этого исключения или null , если причина отсутствует или неизвестна.
С момента:
1.4
См. также:
  • initCause(Throwable)

initCause

public Throwable initCause(Throwable cause)
Инициализирует причину этого исключения заданным значением. Причина — исключительная ситуация, которая привела к выбрасыванию этого исключения именования.

Этот метод можно вызвать не более одного раза.

Переопределяет:
initCause в классе Throwable
Параметры:
cause - причина, которая сохраняется для последующего извлечения методом getCause(). Значение null указывает на отсутствие или неизвестность причины.
Возвращает:
ссылка на этот экземпляр NamingException.
Выбрасывает:
IllegalArgumentException - если cause является этим исключением. (Исключительная ситуация не может быть своей собственной причиной.)
IllegalStateException - если этот метод уже был вызван для этого исключения.
С момента:
1.4
См. также:
  • getCause()

toString

public String toString()
Генерирует строковое представление этого исключения. Строковое представление состоит из имени класса исключения, его подробного сообщения и, если есть корневая причина, строкового представления исключения корневой причины, за которым следует оставшееся имя (если оно не null). Эта строка используется для отладки и не предназначена для программной интерпретации.
Переопределяет:
toString в классе Throwable
Возвращает:
Непустая строка, содержащая строковое представление этого исключения.

toString

public String toString(boolean detail)
Генерирует более подробное строковое представление. Это строковое представление состоит из информации, возвращаемой методом toString() без параметров, плюс строковое представление разрешённого объекта (если он не null). Эта строка используется для отладки и не предназначена для программной интерпретации.
Параметры:
detail - Если true, включить подробности о разрешённом объекте в дополнение к другой информации.
Возвращает:
Непустая строка, содержащая строковое представление.

© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.naming/javax/naming/NamingException.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API