org.androidtransfuse.adapter.PackageClass Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of transfuse-support Show documentation
The newest version!
/**
 * Copyright 2011-2015 John Ericksen
 *
 * Licensed 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.androidtransfuse.adapter;

import org.apache.commons.lang.StringUtils;
import org.apache.commons.lang.builder.EqualsBuilder;
import org.apache.commons.lang.builder.HashCodeBuilder;

/**
 * Class to deal with parsing and outputting class names including package and file extension.
 *
 * @author John Ericksen
 */
public class PackageClass {

    private static final String DOT_JAVA = ".java";

    private final String pkg;
    private final String fileName;

    /**
     * Constructor taking a fully qualified class name, including optional package and filename.
     *
     * This fully qualified name must not end with .java, as this will be interpreted as the class name.
     *
     * This constructor does not work with inner classes as it assumes the last substring is the Class name and
     * everything else is the package name.
     *
     * @param fullyQualifiedName class name
     */
    protected PackageClass(String fullyQualifiedName) {
        String processedName = removeDotJava(fullyQualifiedName);
        int dotIndex = processedName.lastIndexOf('.');
        if (dotIndex == -1) {
            this.pkg = null;
            this.fileName = removeDotJava(processedName);
        } else {
            this.pkg = processedName.substring(0, dotIndex);
            this.fileName = removeDotJava(processedName.substring(dotIndex + 1));
        }
    }

    /**
     * Constructor taking the package and file names.  This constructor defaults the output to not end with .java.
     *
     * @param pkg      package name
     * @param fileName file name
     */
    public PackageClass(String pkg, String fileName) {
        this.pkg = pkg;
        this.fileName = removeDotJava(fileName);
    }

    /**
     * Constructor that parses the class package and name from the input class
     *
     * @param inputClass input
     */
    public PackageClass(Class inputClass) {
        String canonicalName = inputClass.getCanonicalName();
        if (inputClass.getPackage() != null) {
            this.pkg = inputClass.getPackage().getName();
            if (canonicalName != null) {
                this.fileName = canonicalName.substring(this.pkg.length() + 1);
            } else {
                this.fileName = inputClass.getName().substring(inputClass.getPackage().getName().length() + 1).replace('$', '.');
            }
        } else {
            this.fileName = canonicalName;
            this.pkg = null;
        }
    }

    private String removeDotJava(String input) {
        if (input.endsWith(DOT_JAVA)) {
            return input.substring(0, input.length() - DOT_JAVA.length());
        }
        return input;
    }

    /**
     * Builds and returns the name of the class represented by this builder
     *
     * @return class name
     */
    public String getClassName() {
        return removeDotJava(fileName).replace('.', '$');
    }

    /**
     * Builds and returns the fully qualified class name represented by this class
     *
     * @return fully qualified class name
     */
    public String getFullyQualifiedName() {
        if (StringUtils.isEmpty(pkg)) {
            return getClassName();
        }
        return pkg + "." + getClassName();
    }

    public String getPackage() {
        return pkg == null? "" : pkg;
    }

    /**
     * Appends to the class name the given input
     *
     * @param addName input to be appended
     * @return the updated immutable package class
     */
    public PackageClass append(String addName) {
        return new PackageClass(pkg, fileName + addName);
    }

    /**
     * Preprends to the class name the given input
     *
     * @param prepend
     * @return the updated immutable package class
     */
    public PackageClass prepend(String prepend) {
        return new PackageClass(pkg, prepend + fileName);
    }

    /**
     * Replaces the name of the current class with the given input.
     *
     * @param replacement input
     * @return this for method chaining
     */
    public PackageClass replaceName(String replacement) {
        return new PackageClass(pkg, replacement);
    }

    public String toString() {
        return getCanonicalName();
    }

    @Override
    public boolean equals(Object obj) {
        if (!(obj instanceof PackageClass)) {
            return false;
        }
        if (this == obj) {
            return true;
        }
        PackageClass rhs = (PackageClass) obj;
        return new EqualsBuilder()
                .append(fileName, rhs.fileName)
                .append(pkg, rhs.pkg)
                .isEquals();
    }

    @Override
    public int hashCode() {
        return new HashCodeBuilder().append(pkg).append(fileName).hashCode();
    }

    public String getCanonicalName() {
        if (pkg == null) {
            return fileName;
        }
        return pkg + "." + fileName;
    }

    public PackageClass replacePackage(String inputPackage) {
        return new PackageClass(inputPackage, fileName);
    }
}