org.sonar.classloader.ClassloaderRef Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sonar-core Show documentation

Open source platform for continuous inspection of code quality

There is a newer version: 24.12.0.100206

/*
 * SonarQube
 * Copyright (C) 2009-2024 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonar.classloader;

import java.net.URL;
import java.util.Collection;
import javax.annotation.CheckForNull;

interface ClassloaderRef {

  /**
   * Does not throw {@link java.lang.ClassNotFoundException} but returns null
   * when class is not found
   *
   * @param name name of class, for example "org.foo.Bar"
   */
  @CheckForNull
  Class loadClassIfPresent(String name);

  /**
   * Searches for a resource. Returns null if not found.
   *
   * @param name name of resource, for example "org/foo/Bar.class" or "org/foo/config.xml"
   */
  @CheckForNull
  URL loadResourceIfPresent(String name);

  /**
   * Searches for all the occurrences of a resource from hierarchy of classloaders.
   * Results are appended to the parameter "appendTo". Order of resources is given by the
   * hierarchy order of classloaders.
   *
   * @see #loadResourceIfPresent(String) for the format of resource name
   */
  void loadResources(String name, Collection appendTo);
}