Класс ClassLoader

protected ClassLoader(String name, ClassLoader parent)

Примечание к API:

Если в качестве родительского загрузчика указан null (для загрузчика классов начальной загрузки), нет гарантии, что будут видны все платформенные классы.

Параметры:

name — имя загрузчика классов; или null, если имя не задано

parent — родительский загрузчик классов

Исключения:

IllegalArgumentException — если заданное имя пусто.

Начиная с версии:

9

protected ClassLoader(ClassLoader parent)

Примечание к API:

Если в качестве родительского загрузчика указан null (для загрузчика классов начальной загрузки), нет гарантии, что будут видны все платформенные классы.

Параметры:

parent — родительский загрузчик классов

Начиная с версии:

1.2

protected ClassLoader()

public String getName()

Примечание к API:

Для обеспечения совместимости этот метод не является окончательным. Если метод переопределен, он должен возвращать то же имя, которое было указано при создании этого загрузчика классов.

Возвращает:

имя этого загрузчика классов; или null, если имя этому загрузчику классов не задано.

Начиная с версии:

9

public Class<?> loadClass(String name) throws ClassNotFoundException

Параметры:

name — двоичное имя класса

Возвращает:

полученный объект Class

Исключения:

ClassNotFoundException — если класс не найден

protected Class<?> loadClass(String name, boolean resolve) throws ClassNotFoundException

Параметры:

name — двоичное имя класса

resolve — если true, разрешить класс

Возвращает:

полученный объект Class

Исключения:

ClassNotFoundException — если класс не удалось найти

protected Object getClassLoadingLock(String className)

Примечание к API:

Этот метод позволяет загрузчикам классов, поддерживающим параллельную загрузку, реализовывать более детализированные схемы блокировок, благодаря которым несколько потоков могут загружать классы одновременно без взаимных блокировок. Для загрузчиков классов, не поддерживающих параллельную загрузку, во время операций загрузки классов синхронизация выполняется по объекту ClassLoader. Загрузчики классов с недревовидным делегированием следует регистрировать как поддерживающие параллельную загрузку, чтобы предотвратить взаимные блокировки.

Требования к реализации:

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

Параметры:

className — имя загружаемого класса

Возвращает:

блокировку для операций загрузки классов

Исключения:

NullPointerException — если загрузчик зарегистрирован как поддерживающий параллельную загрузку, а className имеет значение null

Начиная с версии:

1.7

См. также:

• loadClass(String, boolean)

protected Class<?> findClass(String name) throws ClassNotFoundException

Требования к реализации:

Реализация по умолчанию выбрасывает ClassNotFoundException.

Параметры:

name — двоичное имя класса

Возвращает:

полученный объект Class

Исключения:

ClassNotFoundException — если класс не удалось найти

Начиная с версии:

1.2

protected Class<?> findClass(String moduleName, String name)

Примечание к API:

Этот метод возвращает null, а не выбрасывает ClassNotFoundException, если класс не удалось найти.

Требования к реализации:

Реализация по умолчанию пытается найти класс, вызывая findClass(String), если moduleName имеет значение null. В противном случае возвращается null.

Параметры:

moduleName — имя модуля; или null, чтобы найти класс в безымянном модуле этого загрузчика классов

name — двоичное имя класса

Возвращает:

полученный объект Class или null, если класс не удалось найти.

Начиная с версии:

9

@Deprecated(since="1.1") protected final Class<?> defineClass(byte[] b, int off, int len) throws ClassFormatError

Параметры:

b — байты, составляющие данные класса. Байты в позициях с off по off+len-1 должны иметь формат корректного файла класса, определенный в документе Спецификация виртуальной машины Java.

off — начальное смещение данных класса в b

len — длина данных класса

Возвращает:

объект Class, созданный на основе указанных данных класса

Исключения:

ClassFormatError — если данные не содержали корректного класса

IndexOutOfBoundsException — если off или len отрицательно либо если off+len больше b.length.

SecurityException — если предпринимается попытка добавить этот класс в пакет, содержащий классы, подписанные набором сертификатов, отличным от набора сертификатов этого класса, либо если предпринимается попытка определить класс в пакете с полным именем, начинающимся с "java.".

См. также:

• loadClass(String, boolean)
• resolveClass(Class)

protected final Class<?> defineClass(String name, byte[] b, int off, int len) throws ClassFormatError

Параметры:

name — ожидаемое двоичное имя класса или null, если оно неизвестно

b — байты, составляющие данные класса. Байты в позициях с off по off+len-1 должны иметь формат корректного файла класса, определенный в документе Спецификация виртуальной машины Java.

off — начальное смещение данных класса в b

len — длина данных класса

Возвращает:

объект Class, созданный на основе указанных данных класса.

Исключения:

ClassFormatError — если данные не содержали корректного класса

IndexOutOfBoundsException — если off или len отрицательно либо если off+len больше b.length.

SecurityException — если предпринимается попытка добавить этот класс в пакет, содержащий классы, подписанные набором сертификатов, отличным от набора сертификатов этого класса (который не подписан), либо если name начинается с "java.".

Начиная с версии:

1.1

См. также:

• loadClass(String, boolean)
• resolveClass(Class)
• CodeSource
• SecureClassLoader

protected final Class<?> defineClass(String name, byte[] b, int off, int len, ProtectionDomain protectionDomain) throws ClassFormatError

Параметры:

name — ожидаемое двоичное имя класса или null, если оно неизвестно

b — байты, составляющие данные класса. Байты в позициях с off по off+len-1 должны иметь формат корректного файла класса, определенный в документе Спецификация виртуальной машины Java.

off — начальное смещение данных класса в b

len — длина данных класса

protectionDomain — ProtectionDomain класса

Возвращает:

объект Class, созданный на основе данных, и ProtectionDomain.

Исключения:

ClassFormatError — если данные не содержали корректного класса

NoClassDefFoundError — если name не равно null и не совпадает с двоичным именем класса, указанного в b

IndexOutOfBoundsException — если off или len отрицательно либо если off+len больше b.length.

SecurityException — если предпринимается попытка добавить этот класс в пакет, содержащий классы, подписанные набором сертификатов, отличным от набора сертификатов этого класса, либо если name начинается с "java.", а этот загрузчик классов не является загрузчиком классов платформы или его предком.

protected final Class<?> defineClass(String name, ByteBuffer b, ProtectionDomain protectionDomain) throws ClassFormatError

Параметры:

name — ожидаемое двоичное имя класса или null, если оно неизвестно

b — байты, составляющие данные класса. Байты в позициях с b.position() по b.position() + b.limit() -1 должны иметь формат корректного файла класса, определенный в документе Спецификация виртуальной машины Java.

protectionDomain — ProtectionDomain класса или null.

Возвращает:

объект Class, созданный на основе данных, и ProtectionDomain.

Исключения:

ClassFormatError — если данные не содержали корректного класса.

NoClassDefFoundError — если name не равно null и не совпадает с двоичным именем класса, указанного в b

SecurityException — если предпринимается попытка добавить этот класс в пакет, содержащий классы, подписанные набором сертификатов, отличным от набора сертификатов этого класса, либо если name начинается с "java.".

Начиная с версии:

1.5

См. также:

• defineClass(String, byte[], int, int, ProtectionDomain)

protected final void resolveClass(Class<?> c)

Параметры:

c — класс для связывания

Исключения:

NullPointerException — если c имеет значение null.

См. также:

• defineClass(String, byte[], int, int)

protected final Class<?> findSystemClass(String name) throws ClassNotFoundException

Параметры:

name — двоичное имя класса

Возвращает:

объект Class для указанного name

Исключения:

ClassNotFoundException — если класс не удалось найти

См. также:

• ClassLoader(ClassLoader)
• getParent()

protected final Class<?> findLoadedClass(String name)

Параметры:

name — двоичное имя класса

Возвращает:

объект Class или null, если класс не был загружен

Начиная с версии:

1.1

protected final void setSigners(Class<?> c, Object[] signers)

Параметры:

c — объект Class

signers — лица, подписавшие класс

Начиная с версии:

1.1

protected URL findResource(String moduleName, String name) throws IOException

Примечание к API:

Этот метод служит основой для методов Class.getResource, Class.getResourceAsStream и Module.getResourceAsStream. На него не распространяются правила инкапсуляции, заданные в Module.getResourceAsStream.

Требования к реализации:

Реализация по умолчанию пытается найти ресурс, вызывая findResource(String), если moduleName имеет значение null. В противном случае возвращается null.

Параметры:

moduleName — имя модуля; или null, чтобы найти ресурс в безымянном модуле этого загрузчика классов

name — имя ресурса

Возвращает:

URL ресурса; null, если ресурс не удалось найти, не удалось создать URL для его поиска или загрузчику классов не определен модуль с указанным именем.

Исключения:

IOException — при возникновении ошибок ввода-вывода

Начиная с версии:

9

См. также:

• ModuleReader.find(String)

public URL getResource(String name)

Примечание к API:

Если одному загрузчику классов определено несколько модулей и более одного из них содержат ресурс с указанным именем, порядок поиска по модулям не определен и может быть весьма непредсказуемым. При переопределении этого метода рекомендуется обеспечить согласованность делегирования с методом getResources(String).

Требования к реализации:

Реализация по умолчанию сначала ищет ресурс в родительском загрузчике классов; если родительский загрузчик — null, поиск выполняется по пути загрузчика классов, встроенного в виртуальную машину. Если ресурс не найден, этот метод вызывает findResource(String) для поиска ресурса.

Параметры:

name — имя ресурса

Возвращает:

URL для чтения ресурса; null, если ресурс не удалось найти, не удалось создать URL для его поиска или ресурс находится в пакете, который не открыт безусловно.

Исключения:

NullPointerException — если name имеет значение null

Начиная с версии:

1.1

public Enumeration<URL> getResources(String name) throws IOException

Примечание API:

Если несколько модулей определены одним и тем же загрузчиком классов и более одного модуля содержит ресурс с указанным именем, порядок не определён и может быть совершенно непредсказуемым. При переопределении этого метода рекомендуется обеспечить согласованность делегирования с методом getResource(String). Это должно гарантировать, что первый элемент, возвращаемый методом nextElement перечисления, является тем же ресурсом, который вернул бы метод getResource(String).

Требования к реализации:

Реализация по умолчанию сначала выполняет поиск ресурса в родительском загрузчике классов; если родительский загрузчик равен null, поиск выполняется по пути загрузчика классов, встроенного в виртуальную машину. Затем вызывается findResources(String) для поиска ресурсов с указанным именем в этом загрузчике классов. Возвращается перечисление, элементы которого — URL-адреса, найденные сначала при поиске в родительском загрузчике классов, а затем с помощью findResources.

Параметры:

name — имя ресурса

Возвращает:

Перечисление объектов URL для ресурса. Если ресурсы не найдены, перечисление будет пустым. Ресурсы, для которых невозможно создать URL, или которые находятся в пакете, не открытом безусловно, в перечисление не включаются.

Исключения:

IOException — если произошли ошибки ввода-вывода

NullPointerException — если name равно null

С версии:

1.2

public Stream<URL> resources(String name)

Примечание API:

При переопределении этого метода рекомендуется обеспечить согласованность делегирования с методом getResource(String). Это должно гарантировать, что первый элемент потока является тем же ресурсом, который вернул бы метод getResource(String).

Требования к реализации:

Реализация по умолчанию вызывает getResources для поиска всех ресурсов с указанным именем и возвращает поток, источником которого являются элементы перечисления.

Параметры:

name — имя ресурса

Возвращает:

Поток объектов-ресурсов URL. Если ресурсы не найдены, поток будет пустым. Ресурсы, для которых невозможно создать URL, или которые находятся в пакете, не открытом безусловно, в поток не включаются.

Исключения:

NullPointerException — если name равно null

С версии:

9

protected URL findResource(String name)

Требования к реализации:

Реализация по умолчанию возвращает null.

Параметры:

name — имя ресурса

Возвращает:

Объект URL для чтения ресурса; null, если ресурс не найден, невозможно создать URL для поиска ресурса или ресурс находится в пакете, не открытом безусловно.

С версии:

1.2

protected Enumeration<URL> findResources(String name) throws IOException

Требования к реализации:

Реализация по умолчанию возвращает перечисление, не содержащее элементов.

Параметры:

name — имя ресурса

Возвращает:

Перечисление объектов URL для ресурса. Если ресурсы не найдены, перечисление будет пустым. Ресурсы, для которых невозможно создать URL, или которые находятся в пакете, не открытом безусловно, в перечисление не включаются.

Исключения:

IOException — если произошли ошибки ввода-вывода

С версии:

1.2

protected static boolean registerAsParallelCapable()

Возвращает:

true, если вызывающий класс успешно зарегистрирован как способный к параллельной загрузке, и false в противном случае.

Исключения:

IllegalCallerException — если вызывающий класс не является подклассом ClassLoader

С версии:

1.7

См. также:

• isRegisteredAsParallelCapable()

public final boolean isRegisteredAsParallelCapable()

Возвращает:

true, если этот загрузчик классов способен к параллельной загрузке, иначе false.

С версии:

9

См. также:

• registerAsParallelCapable()

public static URL getSystemResource(String name)

Параметры:

name — имя ресурса

Возвращает:

URL ресурса; null, если ресурс не найден, невозможно создать URL-адрес для поиска ресурса или ресурс находится в пакете, не открытом безусловно.

С версии:

1.1

public static Enumeration<URL> getSystemResources(String name) throws IOException

Параметры:

name — имя ресурса

Возвращает:

Перечисление объектов URL для ресурса. Если ресурсы не найдены, перечисление будет пустым. Ресурсы, для которых невозможно создать URL, или которые находятся в пакете, не открытом безусловно, в перечисление не включаются.

Исключения:

IOException — если произошли ошибки ввода-вывода

С версии:

1.2

public InputStream getResourceAsStream(String name)

Параметры:

name — имя ресурса

Возвращает:

Входной поток для чтения ресурса; null, если ресурс не найден или находится в пакете, не открытом безусловно.

Исключения:

NullPointerException — если name равно null

С версии:

1.1

public static InputStream getSystemResourceAsStream(String name)

Параметры:

name — имя ресурса

Возвращает:

Входной поток для чтения ресурса; null, если ресурс не найден или находится в пакете, не открытом безусловно.

С версии:

1.1

public final ClassLoader getParent()

Возвращает:

Родительский ClassLoader

С версии:

1.2

public final Module getUnnamedModule()

Возвращает:

Безымянный модуль этого загрузчика классов

С версии:

9

См. также:

• Module.isNamed()

public static ClassLoader getPlatformClassLoader()

Примечание к реализации:

Имя встроенного загрузчика классов платформы — "platform".

Возвращает:

Загрузчик классов платформы ClassLoader.

С версии:

9

public static ClassLoader getSystemClassLoader()

Примечание к реализации:

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

Имя встроенного системного загрузчика классов — "app". Системное свойство «java.class.path» считывается на раннем этапе инициализации виртуальной машины для определения пути классов. Пустое значение свойства «java.class.path» интерпретируется по-разному в зависимости от того, является ли начальный модуль (модуль, содержащий главный класс) именованным или безымянным. Если он именованный, встроенный системный загрузчик классов не будет иметь пути классов и будет искать классы и ресурсы по пути модулей приложения; если он безымянный, путь классов будет задан как текущий рабочий каталог.

JAR-файлы в пути классов могут содержать атрибут манифеста Class-Path, указывающий зависимые JAR-файлы, которые следует включить в путь классов. Записи Class-Path должны удовлетворять определённым условиям, чтобы считаться допустимыми (подробности см. в спецификации JAR-файлов). Недопустимые записи Class-Path игнорируются. Для отладки игнорируемые записи можно выводить в консоль, если системное свойство jdk.net.URLClassPath.showIgnoredClassPathEntries задано значением true.

Возвращает:

Системный ClassLoader

Исключения:

IllegalStateException — если метод рекурсивно вызван во время создания загрузчика классов, указанного свойством «java.system.class.loader».

Error — если системное свойство «java.system.class.loader» задано, но указанный класс не удалось загрузить, класс-поставщик не определяет требуемый конструктор или при его вызове выбрасывается исключение. Первопричину ошибки можно получить с помощью метода Throwable.getCause().

protected Package definePackage(String name, String specTitle, String specVersion, String specVendor, String implTitle, String implVersion, String implVendor, URL sealBase)

Примечание API:

Загрузчик классов, которому нужно определить пакет для классов в JAR-файле, обычно использует название спецификации и реализации, версии и сведения о поставщике из манифеста JAR-файла. Если в манифесте JAR-файла пакет указан как запечатанный, в качестве sealBase обычно используется URL JAR-файла. Если классы пакета 'p', определённого этим загрузчиком классов, загружаются из нескольких JAR-файлов, объект Package может содержать разные сведения в зависимости от того, какой класс пакета 'p' был определён первым и манифест какого JAR-файла первым прочитан для явного определения пакета 'p'.

Настоятельно рекомендуется не вызывать этот метод для явного определения пакетов в именованных модулях; вместо этого пакет будет определён автоматически при определении класса. Если необходимо явно определить Package, следует обеспечить, чтобы все пакеты именованного модуля были определены со свойствами, указанными в Package. В противном случае некоторые объекты Package в именованном модуле могут, например, быть запечатаны с разной базой запечатывания.

Параметры:

name — имя пакета

specTitle — название спецификации

specVersion — версия спецификации

specVendor — поставщик спецификации

implTitle — название реализации

implVersion — версия реализации

implVendor — поставщик реализации

sealBase — если значение не равно null, пакет запечатывается относительно указанного объекта URL источника кода. В противном случае пакет не запечатывается.

Возвращает:

Вновь определённый объект Package

Исключения:

NullPointerException — если name равно null.

IllegalArgumentException — если пакет с указанным name уже определён этим загрузчиком классов

См. Спецификацию виртуальной машины Java:

5.3 Создание и загрузка

С версии:

1.2

См. также:

• Спецификация JAR-файлов: запечатывание пакетов

public final Package getDefinedPackage(String name)

Параметры:

name — имя пакета

Возвращает:

Package с указанным именем, определённый этим загрузчиком классов, или null, если он не найден

Исключения:

NullPointerException — если name равно null.

См. Спецификацию виртуальной машины Java:

5.3 Создание и загрузка

С версии:

9

public final Package[] getDefinedPackages()

Примечание API:

Этот метод возвращает массив, а не Set или Stream, чтобы соответствовать существующему методу getPackages().

Возвращает:

Массив объектов Package, определённых этим загрузчиком классов; если загрузчик классов не определил ни одного пакета, возвращается массив нулевой длины.

См. Спецификацию виртуальной машины Java:

5.3 Создание и загрузка

С версии:

9

@Deprecated(since="9") protected Package getPackage(String name)

Примечание API:

platform class loader может делегировать загрузку загрузчику классов приложения, но загрузчик классов приложения не является его предком. При вызове для загрузчика классов платформы этот метод не найдёт пакеты, определённые загрузчику классов приложения.

Параметры:

name — имя пакета

Возвращает:

Package с указанным именем, определённый этим загрузчиком классов или его предками, либо null, если он не найден.

Исключения:

NullPointerException — если name равно null.

С версии:

1.2

См. также:

• getDefinedPackage(String)

protected Package[] getPackages()

Примечание API:

platform class loader может делегировать загрузку загрузчику классов приложения. Иными словами, пакеты модулей, определённых загрузчику классов приложения, могут быть видны загрузчику классов платформы. С другой стороны, загрузчик классов приложения не является его предком, поэтому при вызове для загрузчика классов платформы этот метод не возвращает пакеты, определённые загрузчику классов приложения.

Возвращает:

Массив объектов Package, определённых этим загрузчиком классов и его предками

С версии:

1.2

См. также:

• getDefinedPackages()

protected String findLibrary(String libname)

Параметры:

libname - Имя библиотеки

Возвращает:

Абсолютный путь к собственной библиотеке

С версии:

1.2

См. также:

• System.loadLibrary(String)^RESTRICTED
• System.mapLibraryName(String)

public void setDefaultAssertionStatus(boolean enabled)

Параметры:

enabled - true, если для классов, загружаемых этим загрузчиком классов, впредь следует включать утверждения по умолчанию; false, если утверждения по умолчанию следует отключить.

С версии:

1.4

public void setPackageAssertionStatus(String packageName, boolean enabled)

Параметры:

packageName - Имя пакета, для которого требуется задать статус утверждений по умолчанию. Значение null обозначает безымянный пакет, который является «текущим» (см. раздел §7.4.2 в Спецификации языка Java.)

enabled - true, если для классов, загружаемых этим загрузчиком классов и принадлежащих указанному пакету или любому из его подпакетов, следует включать утверждения по умолчанию; false, если утверждения по умолчанию следует отключить.

С версии:

1.4

public void setClassAssertionStatus(String className, boolean enabled)

Параметры:

className - Полное имя класса верхнего уровня, для которого требуется задать статус утверждений.

enabled - true, если для указанного класса следует включить утверждения при его инициализации (если она произойдёт); false, если утверждения для класса следует отключить.

С версии:

1.4

public void clearAssertionStatus()

С версии:

1.4