org.redline_rpm.ant.RpmFileSet Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of redline-td Show documentation
Redline is a pure Java library for manipulating RPM Package Manager packages.
The newest version!
package org.redline_rpm.ant;

import org.apache.tools.ant.types.FileSet;
import org.apache.tools.ant.types.TarFileSet;
import org.redline_rpm.payload.Directive;

/**
 * A {@code RpmFileSet} is a {@link FileSet} to support RPM directives that can't be expressed
 * using ant's built-in {@code FileSet} classes.
 */
public class RpmFileSet extends TarFileSet {

    /**
     * A bit num representing the RPM file attributes.
     *
     * @see org.redline_rpm.payload.Directive
     */
    private Directive directive = new Directive();

    /**
     * Constructor for {@code RpmFileSet}
     */
    public RpmFileSet() {
        super();
    }

    /**
     * Constructor using a fileset arguement.
     *
     * @param fileset the {@link FileSet} to use
     */
    protected RpmFileSet(FileSet fileset) {
        super(fileset);
    }

    /**
     * Constructor using a archive fileset argument.
     *
     * @param fileset the {@code RpmFileSet} to use
     */
    protected RpmFileSet(RpmFileSet fileset) {
        super(fileset);
        directive = fileset.directive;
    }

    public Directive getDirective() {
        return directive;
    }

    /**
     * Supports RPM's {@code %ghost} directive, used to flag the specified file as being a ghost file.
     * By adding this directive to the line containing a file, RPM will know about the ghosted file, but will
     * not add it to the package.
     * Permitted values for this directive are:
     * 
     *  {@code true}    (equivalent to specifying {@code %ghost}
     * 
 {@code false}     (equivalent to omitting {@code %ghost})
     * 
     *
     * @see rpm.com
     * @see #directive
     *
     * @param ghost to set
     */
    public void setGhost(boolean ghost) {
        checkRpmFileSetAttributesAllowed();
        if(ghost) {
            directive.set(Directive.RPMFILE_GHOST);
        } else {
            directive.unset(Directive.RPMFILE_GHOST);
        }
    }

    /**
     * Supports RPM's {@code %config} directive, used to flag the specified file as being a configuration file.
     * RPM performs additional processing for config files when packages are erased, and during installations
     * and upgrades.
     * Permitted values for this directive are:
     * 
     *  {@code true}    (equivalent to specifying {@code %config}
     * 
 {@code false}     (equivalent to omitting {@code %config})
     * 
     *
     * @see rpm.com
     * @see #directive
     *
     * @param config to set
     */
    public void setConfig(boolean config) {
        checkRpmFileSetAttributesAllowed();
        if(config) {
            directive.set(Directive.RPMFILE_CONFIG);
        } else {
            directive.unset(Directive.RPMFILE_CONFIG);
        }
    }

    /**
     * Supports RPM's {@code %config(noreplace)} directive. This directive modifies how RPM manages edited config
     * files.
     * Permitted values for this directive are:
     * 
     *  {@code true}    (equivalent to specifying {@code %noreplace}
     * 
 {@code false}     (equivalent to omitting {@code %noreplace})
     * 
     *
     * @see {@code noreplace} details
     * @see #directive
     *
     * @param noReplace to set
     */
    public void setNoReplace(boolean noReplace) {
        checkRpmFileSetAttributesAllowed();
        if(noReplace) {
            directive.set(Directive.RPMFILE_NOREPLACE);
        } else {
            directive.unset(Directive.RPMFILE_NOREPLACE);
        }
    }

    /**
     * Supports RPM's {@code %doc} directive, which flags the files as being documentation.  RPM keeps track of
     * documentation files in its database, so that a user can easily find information about an installed package.
     * Permitted values for this directive are:
     * 
     *  {@code true}    (equivalent to specifying {@code %doc}
     * 
 {@code false}     (equivalent to omitting {@code %doc})
     * 
     *
     * @see rpm.com
     * @see #directive
     *
     * @param doc to set
     */
    public void setDoc(boolean doc) {
        checkRpmFileSetAttributesAllowed();
        if(doc) {
            directive.set(Directive.RPMFILE_DOC);
        } else {
            directive.unset(Directive.RPMFILE_DOC);
        }
    }

    /**
     * Return a ArchiveFileSet that has the same properties
     * as this one.
     *
     * @return the cloned archiveFileSet
     */
    public Object clone() {
        if (isReference()) {
            return getRef(getProject()).clone();
        }
        return super.clone();
    }

    /**
     * A check attributes for TarFileSet.
     * If there is a reference, and
     * it is a TarFileSet, the tar fileset attributes
     * cannot be used.
     */
    private void checkRpmFileSetAttributesAllowed() {
        if (getProject() == null
                || (isReference()
                && (getRefid().getReferencedObject(
                getProject())
                instanceof RpmFileSet))) {
            checkAttributesAllowed();
        }
    }
}