Spec-Zone.ru › OpenJDK 21

Класс 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, что означает, что поле разрешенного имени не было установлено.
См. также:
  • getResolvedObj()
  • setResolvedName(javax.naming.Name)

getRemainingName

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

getResolvedObj

public Object getResolvedObj()
Возвращает объект, для которого разрешение прошло успешно. Это объект, к которому привязано разрешенное имя.
Возвращает:
Возможный null объект, который был разрешен до сих пор. null означает, что поле разрешенного объекта не было установлено.
См. также:
  • 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 не влияют на поле remaining name в этом NamingException и наоборот.

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

getRootCause

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

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

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

setRootCause

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

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

Параметры:
e - Возможное исключение, вызвавшее сбой операции именования. Если 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, 2023, 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/21/docs/api/java.naming/javax/naming/NamingException.html

Spec-Zone.ru

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