com.sun.faces.application.resource.LibraryInfo Maven / Gradle / Ivy
Show all versions of javax.faces Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2011 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.faces.application.resource;
/**
*
* LibraryInfo is a simple wrapper class for information pertainant to building
* a complete resource path using a Library.
*
*/
public class LibraryInfo {
private String name;
private VersionInfo version;
private String localePrefix;
private ResourceHelper helper;
private String path;
/**
* Constructs a new LibraryInfo using the specified details.
* @param name the name of the library
* @param version the version of the library, if any
* @param helper the helper class for this resource
*/
LibraryInfo(String name,
VersionInfo version,
String localePrefix,
ResourceHelper helper) {
this.name = name;
this.version = version;
this.localePrefix = localePrefix;
this.helper = helper;
initPath();
}
@Override
public boolean equals(Object obj) {
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
if (this == obj) {
return true;
}
final LibraryInfo other = (LibraryInfo) obj;
if ((this.name == null) ? (other.name != null) : !this.name.equals(other.name)) {
return false;
}
if (this.version != other.version && (this.version == null || !this.version.equals(other.version))) {
return false;
}
if ((this.localePrefix == null) ? (other.localePrefix != null) : !this.localePrefix.equals(other.localePrefix)) {
return false;
}
if ((this.path == null) ? (other.path != null) : !this.path.equals(other.path)) {
return false;
}
return true;
}
@Override
public int hashCode() {
int hash = 5;
hash = 37 * hash + (this.name != null ? this.name.hashCode() : 0);
hash = 37 * hash + (this.version != null ? this.version.hashCode() : 0);
hash = 37 * hash + (this.localePrefix != null ? this.localePrefix.hashCode() : 0);
hash = 37 * hash + (this.path != null ? this.path.hashCode() : 0);
return hash;
}
/**
* @return return the library name.
*/
public String getName() {
return name;
}
/**
* @return return the version of the library, or null
* if the library isn't versioned.
*/
public VersionInfo getVersion() {
return version;
}
/**
* @return return the {@link ResourceHelper} for this resource
*/
public ResourceHelper getHelper() {
return helper;
}
/**
* @return the base path of the library.
*/
public String getPath() {
return path;
}
/**
* @return the Locale prefix, if any.
*/
public String getLocalePrefix() {
return localePrefix;
}
public String toString() {
return "LibraryInfo{" +
"name='" + name + '\'' +
", version=" + ((version != null) ? version : "NONE") + '\'' +
", localePrefix='" + ((localePrefix != null) ? localePrefix : "NONE") + '\'' +
", path='" + path + '\'' +
'}';
}
// --------------------------------------------------------- Private Methods
/**
* Construct the full path to the base directory of the library's resources.
*/
private void initPath() {
StringBuilder sb = new StringBuilder(64);
sb.append(helper.getBaseResourcePath());
if (localePrefix != null) {
sb.append('/').append(localePrefix);
}
sb.append('/').append(name);
if (version != null) {
sb.append('/').append(version.getVersion());
}
path = sb.toString();
}
}