org.codehaus.mojo.jaxb2.schemageneration.postprocessing.javadoc.location.ClassLocation Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jaxb2-maven-plugin Show documentation
Show all versions of jaxb2-maven-plugin Show documentation
Mojo's JAXB-2 Maven plugin is used to create an object graph
from XSDs based on the JAXB 2.x implementation and to generate XSDs
from JAXB annotated Java classes.
package org.codehaus.mojo.jaxb2.schemageneration.postprocessing.javadoc.location;
/*
* 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.
*/
import org.codehaus.mojo.jaxb2.shared.Validate;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlType;
/**
* Comparable path structure to locate a particular class within compilation unit.
*
* @author Lennart Jörelid, jGuru Europe AB
* @since 2.0
*/
public class ClassLocation extends PackageLocation {
// Internal state
private String className;
private String classXmlName;
/**
* Creates a new ClassLocation with the supplied package and class names.
*
* @param packageName The name of the package for a class potentially holding JavaDoc. Cannot be {@code null}.
* @param classXmlName The name given as the {@link XmlType#name()} value of an annotation placed on the Class,
* or {@code null} if none is provided.
* @param className The (simple) name of a class. Cannot be null or empty.
*/
public ClassLocation(final String packageName, final String className, final String classXmlName) {
super(packageName);
// Check sanity
Validate.notEmpty(className, "className");
// Assign internal state
this.className = className;
this.classXmlName = classXmlName;
}
/**
* Retrieves the simple class name for the class potentially holding JavaDoc. Never {@code null} or empty.
*
* @return The simple class name for the class potentially holding JavaDoc. Never {@code null} or empty.
*/
public String getClassName() {
return classXmlName == null ? className : classXmlName;
}
/**
* Always appends the effective className to the path from the superclass {@link PackageLocation}.
* If the {@link #getAnnotationRenamedTo()} method returns a non-null value, that value is the effective className.
* Otherwise, the {@link #getClassName()} method is used as the effective className.
*
* This is to handle renames such as provided in a {@link javax.xml.bind.annotation.XmlType} annotation's
* {@link XmlType#name()} attribute value.
*
* @return the path of the PackageLocation superclass, appended with the effective className.
* @see XmlType
* @see XmlAttribute#name()
* @see XmlElement#name()
*/
@Override
public String getPath() {
return super.toString() + "." + getClassName();
}
/**
* {@inheritDoc}
*/
@Override
public String getAnnotationRenamedTo() {
return classXmlName;
}
/**
* {@inheritDoc}
*/
@Override
public int hashCode() {
return this.toString().hashCode();
}
/**
* {@inheritDoc}
*/
@Override
public String toString() {
final String xmlOverriddenFrom = classXmlName != null && !className.equals(classXmlName)
? " (from: " + className + ")"
: "";
return super.toString() + "." + getClassName() + xmlOverriddenFrom;
}
}