net.sf.eclipsecs.core.config.CheckConfiguration.java Source code

Introduction

Here is the source code for net.sf.eclipsecs.core.config.CheckConfiguration.java

Source

//============================================================================
//
// Copyright (C) 2002-2014  David Schneider, Lars Kdderitzsch
//
// 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 2.1 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, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
//============================================================================

package net.sf.eclipsecs.core.config;

import java.net.URL;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import net.sf.eclipsecs.core.config.configtypes.IConfigurationType;
import net.sf.eclipsecs.core.util.CheckstylePluginException;

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

/**
 * Base implementation of a check configuration. Leaves the specific tasks to
 * the concrete subclasses.
 * 
 * @author Lars Kdderitzsch
 */
public class CheckConfiguration implements ICheckConfiguration {

    //
    // attributes
    //

    /** the displayable name of the configuration. */
    private final String mName;

    /** the location of the checkstyle configuration file. */
    private final String mLocation;

    /** the description of the configuration. */
    private final String mDescription;

    /** the configuration type. */
    private final IConfigurationType mConfigType;

    /** flags if the configuration is global. */
    private final boolean mIsGlobal;

    /** The list of resolvable properties. */
    private final List<ResolvableProperty> mProperties;

    /** Map containing additional data for this check configuration. */
    private Map<String, String> mAdditionalData;

    /** Cached data of the Checkstyle configuration file. */
    private CheckstyleConfigurationFile mCheckstyleConfigurationFile;

    /** Time stamp when the cached configuration file data expires. */
    private long mExpirationTime = 0;

    //
    // methods
    //

    /**
     * Creates a check configuration instance.
     * 
     * @param name
     *            the name of the check configuration
     * @param location
     *            the location of the check configuration
     * @param description
     *            the description of the check configuration
     * @param type
     *            the check configuration type
     * @param global
     *            determines if the check configuration is a global
     *            configuration
     * @param properties
     *            the list of properties configured for this check configuration
     * @param additionalData
     *            a map of additional data for this configuration
     */
    public CheckConfiguration(final String name, final String location, final String description,
            final IConfigurationType type, final boolean global, final List<ResolvableProperty> properties,
            final Map<String, String> additionalData) {
        mName = name;
        mLocation = location;
        mDescription = description;
        mConfigType = type;
        mIsGlobal = global;

        if (additionalData != null) {
            mAdditionalData = Collections.unmodifiableMap(additionalData);
        } else {
            mAdditionalData = Collections.unmodifiableMap(new HashMap<String, String>());
        }

        mProperties = properties != null ? Collections.unmodifiableList(properties)
                : Collections.unmodifiableList(new ArrayList<ResolvableProperty>());
    }

    /**
     * {@inheritDoc}
     */
    public String getName() {
        return mName;
    }

    /**
     * {@inheritDoc}
     */
    public String getLocation() {
        return mLocation;
    }

    /**
     * {@inheritDoc}
     */
    public String getDescription() {
        return mDescription;
    }

    /**
     * {@inheritDoc}
     */
    public IConfigurationType getType() {
        return mConfigType;
    }

    /**
     * {@inheritDoc}
     */
    public Map<String, String> getAdditionalData() {
        return mAdditionalData;
    }

    /**
     * {@inheritDoc}
     */
    public List<ResolvableProperty> getResolvableProperties() {
        return mProperties;
    }

    /**
     * {@inheritDoc}
     */
    public boolean isEditable() {
        return mConfigType.isEditable();
    }

    /**
     * {@inheritDoc}
     */
    public boolean isConfigurable() {
        return mConfigType.isConfigurable(this);
    }

    /**
     * {@inheritDoc}
     */
    public boolean isGlobal() {
        return mIsGlobal;
    }

    /**
     * {@inheritDoc}
     */
    public URL getResolvedConfigurationFileURL() throws CheckstylePluginException {
        return getType().getResolvedConfigurationFileURL(this);
    }

    /**
     * {@inheritDoc}
     */
    public CheckstyleConfigurationFile getCheckstyleConfiguration() throws CheckstylePluginException {
        final long currentTime = System.currentTimeMillis();

        if ((mCheckstyleConfigurationFile == null) || (currentTime > mExpirationTime)) {
            mCheckstyleConfigurationFile = getType().getCheckstyleConfiguration(this);
            mExpirationTime = currentTime + 1000 * 60 * 60; // 1 hour
        }

        return mCheckstyleConfigurationFile;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public boolean equals(final Object obj) {
        if ((obj == null) || !(obj instanceof ICheckConfiguration)) {
            return false;
        }
        if (this == obj) {
            return true;
        }
        final ICheckConfiguration rhs = (ICheckConfiguration) obj;
        return new EqualsBuilder().append(getName(), rhs.getName()).append(getLocation(), rhs.getLocation())
                .append(getDescription(), rhs.getDescription()).append(getType(), rhs.getType())
                .append(isGlobal(), rhs.isGlobal()).append(getResolvableProperties(), rhs.getResolvableProperties())
                .append(getAdditionalData(), rhs.getAdditionalData()).isEquals();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public int hashCode() {
        return new HashCodeBuilder(928729, 1000003).append(getName()).append(getLocation()).append(getDescription())
                .append(getType()).append(isGlobal()).append(getResolvableProperties()).append(getAdditionalData())
                .toHashCode();
    }
}