http://commons.apache.org/proper/commons-lang/: Apache Commons Lang, a package of Java utility classes for the classes that are in java.lang's hierarchy, or are considered to be so standard as to justify existence in java.lang. (The Apache Software Foundation)
  • C. Scott Ananian
  • Chris Audley
  • Stephane Bailliez
  • Michael Becke
  • Benjamin Bentmann
  • Ola Berg
  • Nathan Beyer
  • Stefan Bodewig
  • Janek Bogucki
  • Mike Bowler
  • Sean Brown
  • Alexander Day Chaffee
  • Al Chou
  • Greg Coladonato
  • Maarten Coene
  • Justin Couch
  • Michael Davey
  • Norm Deane
  • Morgan Delagrange
  • Ringo De Smet
  • Russel Dittmar
  • Steve Downey
  • Matthias Eichel
  • Christopher Elkins
  • Chris Feldhacker
  • Roland Foerther
  • Pete Gieser
  • Jason Gritman
  • Matthew Hawthorne
  • Michael Heuer
  • Chas Honton
  • Chris Hyzer
  • Paul Jack
  • Marc Johnson
  • Shaun Kalley
  • Tetsuya Kaneuchi
  • Nissim Karpenstein
  • Ed Korthof
  • Holger Krauth
  • Rafal Krupinski
  • Rafal Krzewski
  • David Leppik
  • Eli Lindsey
  • Sven Ludwig
  • Craig R. McClanahan
  • Rand McNeely
  • Hendrik Maryns
  • Dave Meikle
  • Nikolay Metchev
  • Kasper Nielsen
  • Tim O'Brien
  • Brian S O'Neill
  • Andrew C. Oliver
  • Alban Peignier
  • Moritz Petersen
  • Dmitri Plotnikov
  • Neeme Praks
  • Eric Pugh
  • Stephen Putman
  • Travis Reeder
  • Antony Riley
  • Valentin Rocher
  • Scott Sanders
  • James Sawle
  • Ralph Schaer
  • Henning P. Schmiedehausen
  • Sean Schofield
  • Robert Scholte
  • Reuben Sivan
  • Ville Skytta
  • David M. Sledge
  • Michael A. Smith
  • Jan Sorensen
  • Glen Stampoultzis
  • Scott Stanchfield
  • Jon S. Stevens
  • Sean C. Sullivan
  • Ashwin Suresh
  • Helge Tesgaard
  • Arun Mammen Thomas
  • Masato Tezuka
  • Daniel Trebbien
  • Jeff Varszegi
  • Chris Webb
  • Mario Winterer
  • Stepan Koltsov
  • Holger Hoffstatte
  • Derek C. Ashmore
  • Sebastien Riou
  • Allon Mureinik
  • Adam Hooper
  • Chris Karcher
  • Michael Osipov
  • Thiago Andrade
  • Jonathan Baker
  • Mikhail Mazursky
  • Fabian Lange
  • Michał Kordas
  • Felipe Adorno
  • Adrian Ber
  • Mark Dacek
  • Daniel Rall (CollabNet, Inc.)
  • Stephen Colebourne (SITA ATS Ltd)
  • Henri Yandell ()
  • Steven Caswell ()
  • Robert Burrell Donkin ()
  • Gary D. Gregory
  • Fredrik Westermarck ()
  • James Carman (Carman Consulting, Inc.)
  • Niall Pemberton
  • Matt Benson
  • Joerg Schaible
  • Oliver Heger
  • Paul Benedict
  • Benedikt Ritter
  • Duncan Jones
  • Loic Guibert
  • Rob Tompkins 
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.commons.lang3;


Operations regarding the classpath.

The methods of this class do not allow null inputs.


Since:3.3
/**
 * Operations regarding the classpath.
 *
 * <p>The methods of this class do not allow {@code null} inputs.</p>
 *
 * @since 3.3
 */
//@Immutable
public class ClassPathUtils {

    
ClassPathUtils instances should NOT be constructed in standard programming. Instead, the class should be used as ClassPathUtils.toFullyQualifiedName(MyClass.class, "MyClass.properties");.


This constructor is public to permit tools that require a JavaBean
instance to operate.


/**
     * <p>{@code ClassPathUtils} instances should NOT be constructed in
     * standard programming. Instead, the class should be used as
     * {@code ClassPathUtils.toFullyQualifiedName(MyClass.class, "MyClass.properties");}.</p>
     *
     * <p>This constructor is public to permit tools that require a JavaBean
     * instance to operate.</p>
     */
    public ClassPathUtils() {
        super();
    }

    
Returns the fully qualified name for the resource with name resourceName relative to the given context. 
Note that this method does not check whether the resource actually exists.
It only constructs the name.
Null inputs are not allowed.


ClassPathUtils.toFullyQualifiedName(StringUtils.class, "StringUtils.properties") = "org.apache.commons.lang3.StringUtils.properties"



Params:
  • context – The context for constructing the name.
  • resourceName – the resource name to construct the fully qualified name for.
Throws:
Returns:the fully qualified name of the resource with name resourceName.
/**
     * Returns the fully qualified name for the resource with name {@code resourceName} relative to the given context.
     *
     * <p>Note that this method does not check whether the resource actually exists.
     * It only constructs the name.
     * Null inputs are not allowed.</p>
     *
     * <pre>
     * ClassPathUtils.toFullyQualifiedName(StringUtils.class, "StringUtils.properties") = "org.apache.commons.lang3.StringUtils.properties"
     * </pre>
     *
     * @param context The context for constructing the name.
     * @param resourceName the resource name to construct the fully qualified name for.
     * @return the fully qualified name of the resource with name {@code resourceName}.
     * @throws java.lang.NullPointerException if either {@code context} or {@code resourceName} is null.
     */
    public static String toFullyQualifiedName(final Class<?> context, final String resourceName) {
        Validate.notNull(context, "Parameter '%s' must not be null!", "context" );
        Validate.notNull(resourceName, "Parameter '%s' must not be null!", "resourceName");
        return toFullyQualifiedName(context.getPackage(), resourceName);
    }

    
Returns the fully qualified name for the resource with name resourceName relative to the given context. 
Note that this method does not check whether the resource actually exists.
It only constructs the name.
Null inputs are not allowed.


ClassPathUtils.toFullyQualifiedName(StringUtils.class.getPackage(), "StringUtils.properties") = "org.apache.commons.lang3.StringUtils.properties"



Params:
  • context – The context for constructing the name.
  • resourceName – the resource name to construct the fully qualified name for.
Throws:
Returns:the fully qualified name of the resource with name resourceName.
/**
     * Returns the fully qualified name for the resource with name {@code resourceName} relative to the given context.
     *
     * <p>Note that this method does not check whether the resource actually exists.
     * It only constructs the name.
     * Null inputs are not allowed.</p>
     *
     * <pre>
     * ClassPathUtils.toFullyQualifiedName(StringUtils.class.getPackage(), "StringUtils.properties") = "org.apache.commons.lang3.StringUtils.properties"
     * </pre>
     *
     * @param context The context for constructing the name.
     * @param resourceName the resource name to construct the fully qualified name for.
     * @return the fully qualified name of the resource with name {@code resourceName}.
     * @throws java.lang.NullPointerException if either {@code context} or {@code resourceName} is null.
     */
    public static String toFullyQualifiedName(final Package context, final String resourceName) {
        Validate.notNull(context, "Parameter '%s' must not be null!", "context" );
        Validate.notNull(resourceName, "Parameter '%s' must not be null!", "resourceName");
        return context.getName() + "." + resourceName;
    }

    
Returns the fully qualified path for the resource with name resourceName relative to the given context. 
Note that this method does not check whether the resource actually exists.
It only constructs the path.
Null inputs are not allowed.


ClassPathUtils.toFullyQualifiedPath(StringUtils.class, "StringUtils.properties") = "org/apache/commons/lang3/StringUtils.properties"



Params:
  • context – The context for constructing the path.
  • resourceName – the resource name to construct the fully qualified path for.
Throws:
Returns:the fully qualified path of the resource with name resourceName.
/**
     * Returns the fully qualified path for the resource with name {@code resourceName} relative to the given context.
     *
     * <p>Note that this method does not check whether the resource actually exists.
     * It only constructs the path.
     * Null inputs are not allowed.</p>
     *
     * <pre>
     * ClassPathUtils.toFullyQualifiedPath(StringUtils.class, "StringUtils.properties") = "org/apache/commons/lang3/StringUtils.properties"
     * </pre>
     *
     * @param context The context for constructing the path.
     * @param resourceName the resource name to construct the fully qualified path for.
     * @return the fully qualified path of the resource with name {@code resourceName}.
     * @throws java.lang.NullPointerException if either {@code context} or {@code resourceName} is null.
     */
    public static String toFullyQualifiedPath(final Class<?> context, final String resourceName) {
        Validate.notNull(context, "Parameter '%s' must not be null!", "context" );
        Validate.notNull(resourceName, "Parameter '%s' must not be null!", "resourceName");
        return toFullyQualifiedPath(context.getPackage(), resourceName);
    }


    
Returns the fully qualified path for the resource with name resourceName relative to the given context. 
Note that this method does not check whether the resource actually exists.
It only constructs the path.
Null inputs are not allowed.


ClassPathUtils.toFullyQualifiedPath(StringUtils.class.getPackage(), "StringUtils.properties") = "org/apache/commons/lang3/StringUtils.properties"



Params:
  • context – The context for constructing the path.
  • resourceName – the resource name to construct the fully qualified path for.
Throws:
Returns:the fully qualified path of the resource with name resourceName.
/**
     * Returns the fully qualified path for the resource with name {@code resourceName} relative to the given context.
     *
     * <p>Note that this method does not check whether the resource actually exists.
     * It only constructs the path.
     * Null inputs are not allowed.</p>
     *
     * <pre>
     * ClassPathUtils.toFullyQualifiedPath(StringUtils.class.getPackage(), "StringUtils.properties") = "org/apache/commons/lang3/StringUtils.properties"
     * </pre>
     *
     * @param context The context for constructing the path.
     * @param resourceName the resource name to construct the fully qualified path for.
     * @return the fully qualified path of the resource with name {@code resourceName}.
     * @throws java.lang.NullPointerException if either {@code context} or {@code resourceName} is null.
     */
    public static String toFullyQualifiedPath(final Package context, final String resourceName) {
        Validate.notNull(context, "Parameter '%s' must not be null!", "context" );
        Validate.notNull(resourceName, "Parameter '%s' must not be null!", "resourceName");
        return context.getName().replace('.', '/') + "/" + resourceName;
    }

}