org.fuin.srcgen4j.commons.BinClasspathEntry Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of srcgen4j-commons Show documentation
Source code generation for Java (Commons)
The newest version!
/**
 * Copyright (C) 2015 Michael Schnell. All rights reserved. 
 * http://www.fuin.org/
 *
 * This library 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 library 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 library. If not, see http://www.gnu.org/licenses/.
 */
package org.fuin.srcgen4j.commons;

import static org.fuin.utils4j.Utils4J.replaceVars;

import java.util.Map;

import javax.annotation.Nullable;
import javax.validation.constraints.NotNull;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;

import org.fuin.xmlcfg4j.AbstractElement;

/**
 * Represents a folder in a target folder.
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlRootElement(name = "bin")
@XmlType(propOrder = "path")
public final class BinClasspathEntry extends AbstractElement implements InitializableElement {

    @NotNull
    @XmlAttribute
    private String path;

    @Nullable
    private transient Classpath parent;

    /**
     * Package visible default constructor for deserialization.
     */
    BinClasspathEntry() { //NOSONAR Ignore not initialized fields
        super();
    }

    /**
     * Constructor with path.
     * 
     * @param path
     *            Path to set.
     */
    public BinClasspathEntry(@NotNull final String path) {
        super();
        this.path = path;
    }

    /**
     * Returns the path.
     * 
     * @return Current path.
     */
    @NotNull
    public final String getPath() {
        return path;
    }

    /**
     * Returns the parent for the folder.
     * 
     * @return Parent.
     */
    @Nullable
    public final Classpath getParent() {
        return parent;
    }

    /**
     * Sets the parent for the folder.
     * 
     * @param parent
     *            Parent.
     */
    public final void setParent(@Nullable final Classpath parent) {
        this.parent = parent;
    }

    @Override
    public final BinClasspathEntry init(final SrcGen4JContext context, final Classpath parent, final Map vars) {
        this.parent = parent;
        inheritVariables(vars);
        path = replaceVars(path, getVarMap());
        return this;
    }

}