Spec-Zone.ru › OpenJDK 17

Ссылка на класс

java.lang.Object
javax.naming.Reference
Все реализованные интерфейсы:
Serializable, Cloneable
Прямые известные подклассы:
LinkRef
public class Reference extends Object implements Cloneable, Serializable
Этот класс представляет ссылку на объект, который находится вне системы именования/каталога.

Reference предоставляет способ записи информации об адресе объектов, которые сами по себе не связаны напрямую с системой именования/каталога.

Ссылка состоит из упорядоченного списка адресов и информации о классе объекта, на который она ссылается. Каждый адрес в списке идентифицирует точку доступа к коммуникациям для одного концептуального объекта. "Точка доступа к коммуникациям" — это информация, указывающая, как связаться с объектом. Это может быть, например, сетевой адрес, местоположение в памяти на локальной машине, другой процесс на той же машине и т. д. Порядок адресов в списке может иметь значение для фабрик объектов, которые интерпретируют ссылку.

Несколько адресов могут возникнуть по разным причинам, таким как репликация или объект, предоставляющий интерфейсы по нескольким механизмам связи. Адреса индексируются, начиная с нуля.

Ссылка также содержит информацию для помощи в создании экземпляра объекта, на который ссылается эта ссылка. Она содержит имя класса этого объекта, а также имя класса и местоположение фабрики, которая должна использоваться для создания объекта. Местоположение фабрики класса — это список URL-адресов, разделенных пробелами, представляющих путь к классу для загрузки фабрики. Когда необходимо загрузить класс фабрики (или любой класс или ресурс, от которого он зависит), каждый URL-адрес используется (в порядке следования) для попытки загрузки класса.

Экземпляр Reference не синхронизирован по отношению к одновременным обращениям с помощью нескольких потоков. Потоки, которым необходимо одновременно получить доступ к одной ссылке, должны синхронизироваться между собой и обеспечить необходимые блокировки.

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

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

Модификатор и тип Поле Описание
protected Vector<RefAddr> addrs
Содержит адреса, содержащиеся в этой ссылке.
protected String classFactory
Содержит имя класса фабрики для создания экземпляра объекта, на который ссылается эта ссылка.
protected String classFactoryLocation
Содержит местоположение класса фабрики.
protected String className
Содержит полное имя класса объекта, на который ссылается эта ссылка.

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

Конструктор Описание
Reference(String className)
Создаёт новую ссылку на объект с именем класса 'className'.
Reference(String className, String factory, String factoryLocation)
Создаёт новую ссылку на объект с именем класса 'className' и именем и местоположением фабрики объекта.
Reference(String className, RefAddr addr)
Создаёт новую ссылку на объект с именем класса 'className' и адресом.
Reference(String className, RefAddr addr, String factory, String factoryLocation)
Создаёт новую ссылку на объект с именем класса 'className', именем и местоположением фабрики объекта, и адресом объекта.

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

Модификатор и тип Метод Описание
void add(int posn, RefAddr addr)
Добавляет адрес в список адресов по индексу posn.
void add(RefAddr addr)
Добавляет адрес в конец списка адресов.
void clear()
Удаляет все адреса из этой ссылки.
Object clone()
Создаёт копию этой ссылки, используя её имя класса, список адресов, имя фабрики класса и местоположение фабрики класса.
boolean equals(Object obj)
Определяет, является ли obj ссылкой с теми же адресами (в том же порядке), что и эта ссылка.
RefAddr get(int posn)
Возвращает адрес по индексу posn.
RefAddr get(String addrType)
Возвращает первый адрес, имеющий тип адреса 'addrType'.
Enumeration<RefAddr> getAll()
Возвращает перечисление адресов в этой ссылке.
String getClassName()
Возвращает имя класса объекта, на который ссылается эта ссылка.
String getFactoryClassLocation()
Возвращает местоположение фабрики объекта, на который ссылается эта ссылка.
String getFactoryClassName()
Возвращает имя класса фабрики объекта, на который ссылается эта ссылка.
int hashCode()
Вычисляет код хэша этой ссылки.
Object remove(int posn)
Удаляет адрес по индексу posn из списка адресов.
int size()
Возвращает количество адресов в этой ссылке.
String toString()
Генерирует строковое представление этой ссылки.

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

finalize, getClass, notify, notifyAll, wait, wait, wait

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

className

protected String className
Содержит полное квалифицированное имя класса объекта, на который ссылается данная ссылка.
См. также:
  • Class.getName()

addrs

protected Vector<RefAddr> addrs
Содержит адреса, содержащиеся в этой ссылке. Инициализируется конструктором.

classFactory

protected String classFactory
Содержит имя класса фабрики для создания экземпляра объекта, на который ссылается данная ссылка. Инициализируется значением null.

classFactoryLocation

protected String classFactoryLocation
Содержит расположение класса фабрики. Инициализируется значением null.

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

Reference

public Reference(String className)
Создаёт новую ссылку на объект с именем класса 'className'. Класс фабрики и расположение класса фабрики устанавливаются в null. Созданная ссылка содержит ноль адресов.
Параметры:
className - Непустое имя класса объекта, на который ссылается эта ссылка.

Reference

public Reference(String className, RefAddr addr)
Создаёт новую ссылку на объект с именем класса 'className' и адресом. Класс фабрики и расположение класса фабрики устанавливаются в null.
Параметры:
className - Непустое имя класса объекта, на который ссылается эта ссылка.
addr - Непустой адрес объекта.

Reference

public Reference(String className, String factory, String factoryLocation)
Создаёт новую ссылку на объект с именем класса 'className' и именем и местоположением класса фабрики объекта.
Параметры:
className - Непустое имя класса объекта, на который ссылается эта ссылка.
factory - Возможно пустое имя класса фабрики объекта.
factoryLocation - Возможно пустое расположение, откуда загружать фабрику (например, URL).
См. также:
  • ObjectFactory
  • NamingManager.getObjectInstance(java.lang.Object, javax.naming.Name, javax.naming.Context, java.util.Hashtable<?, ?>)

Reference

public Reference(String className, RefAddr addr, String factory, String factoryLocation)
Создаёт новую ссылку на объект с именем класса 'className', именем и местоположением класса фабрики объекта и адресом объекта.
Параметры:
className - Непустое имя класса объекта, на который ссылается эта ссылка.
factory - Возможно пустое имя класса фабрики объекта.
factoryLocation - Возможно пустое расположение, откуда загружать фабрику (например, URL).
addr - Непустой адрес объекта.
См. также:
  • ObjectFactory
  • NamingManager.getObjectInstance(java.lang.Object, javax.naming.Name, javax.naming.Context, java.util.Hashtable<?, ?>)

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

getClassName

public String getClassName()
Возвращает имя класса объекта, на который ссылается эта ссылка.
Возвращает:
Непустое полное квалифицированное имя класса объекта (например, "java.lang.String").

getFactoryClassName

public String getFactoryClassName()
Возвращает имя класса фабрики объекта, на который ссылается эта ссылка.
Возвращает:
Возможно пустое полное квалифицированное имя фабрики (например, "java.lang.String").

getFactoryClassLocation

public String getFactoryClassLocation()
Возвращает расположение фабрики объекта, на который ссылается эта ссылка. Если это базовая кодовая база, то это упорядоченный список URL-адресов, разделённых пробелами, перечисляющих расположения, откуда необходимо загрузить определение класса фабрики.
Возвращает:
Возможно пустая строка, содержащая расположение для загрузки класса фабрики.

get

public RefAddr get(String addrType)
Возвращает первый адрес, имеющий тип адреса 'addrType'. Для проверки равенства типов адресов используется String.compareTo().
Параметры:
addrType - Непустой тип адреса, для которого нужно найти адрес.
Возвращает:
Адрес в этой ссылке с типом адреса 'addrType'; null, если такого адреса нет.

get

public RefAddr get(int posn)
Возвращает адрес по индексу posn.
Параметры:
posn - Индекс адреса для извлечения.
Возвращает:
Адрес по 0-основанному индексу posn. Он должен находиться в диапазоне [0, getAddressCount()).
Исключения:
ArrayIndexOutOfBoundsException - Если posn не в указанном диапазоне.

getAll

public Enumeration<RefAddr> getAll()
Возвращает перечисление адресов в этой ссылке. Когда адреса добавляются, изменяются или удаляются из этой ссылки, её влияние на это перечисление не определено.
Возвращает:
Непустое перечисление адресов (RefAddr) в этой ссылке. Если в этой ссылке нет адресов, возвращается перечисление с нулевыми элементами.

size

public int size()
Возвращает количество адресов в этой ссылке.
Возвращает:
Неотрицательное количество адресов в этой ссылке.

add

public void add(RefAddr addr)
Добавляет адрес в конец списка адресов.
Параметры:
addr - Непустой адрес для добавления.

add

public void add(int posn, RefAddr addr)
Добавляет адрес в список адресов по индексу posn. Все адреса с индексом posn или больше сдвигаются вверх по списку на единицу (относительно индекса 0).
Параметры:
posn - 0-основанный индекс списка для вставки addr.
addr - Непустой адрес для добавления.
Исключения:
ArrayIndexOutOfBoundsException - Если posn не в указанном диапазоне.

remove

public Object remove(int posn)
Удаляет адрес по индексу posn из списка адресов. Все адреса с индексом больше posn сдвигаются вниз по списку на единицу (к индексу 0).
Параметры:
posn - 0-основанный индекс адреса для удаления.
Возвращает:
Удаленный адрес.
Исключения:
ArrayIndexOutOfBoundsException - Если posn не в указанном диапазоне.

clear

public void clear()
Удаляет все адреса из этой ссылки.

equals

public boolean equals(Object obj)
Определяет, является ли obj ссылкой с теми же адресами (в том же порядке), что и эта ссылка. Адреса проверяются с помощью RefAddr.equals(). Кроме того, у ссылки также должно быть то же имя класса, что и у этой ссылки. Класс фабрики и расположение класса фабрики не проверяются. Если obj равен null или не является экземпляром Reference, возвращается null.
Переопределяет:
equals в классе Object
Параметры:
obj - Возможно пустой объект для проверки.
Возвращает:
true, если obj равен этой ссылке; false в противном случае.
См. также:
  • Object.hashCode()
  • HashMap

hashCode

public int hashCode()
Вычисляет хэш-код этой ссылки. Хэш-код — это сумма хэш-кодов её адресов.
Переопределяет:
hashCode в классе Object
Возвращает:
Хэш-код этой ссылки как целое число.
См. также:
  • Object.equals(java.lang.Object)
  • System.identityHashCode(java.lang.Object)

toString

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

clone

public Object clone()
Создает копию этой ссылки, используя список имен классов, имя фабрики класса и расположение фабрики класса. Изменения в только что созданной копии не влияют на эту ссылку и наоборот.
Overrides:
clone в классе Object
Возвращает:
клонированный экземпляр.
См. также:
  • Cloneable

© 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/Reference.html

Spec-Zone.ru

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