org.spdx.maven.SpdxDefaultFileInformation Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2014 Source Auditor Inc.
 *
 * 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.spdx.maven;

import java.util.ArrayList;
import java.util.List;

import org.apache.maven.plugin.logging.Log;
import org.spdx.rdfparser.license.AnyLicenseInfo;
import org.spdx.rdfparser.license.SpdxNoAssertionLicense;

/**
 * Simple structure to hold information obout default file information
 * @author Gary O'Neall
 *
 */
public class SpdxDefaultFileInformation 
{

    private AnyLicenseInfo declaredLicense = new SpdxNoAssertionLicense();
    private String copyright = "NOASSERTION";
    private String notice = "";
    private String comment = "";
    private String[] contributors = new String[0];
    private AnyLicenseInfo concludedLicense = new SpdxNoAssertionLicense();;
    private String licenseComment = "";
    private List snippets = new ArrayList();

    public AnyLicenseInfo getDeclaredLicense() 
    {
        return this.declaredLicense;
    }
    
    public void setDeclaredLicense( AnyLicenseInfo license ) 
    {
        this.declaredLicense = license;
    }

    public String getCopyright() 
    {
        return this.copyright ;
    }
    
    public void setCopyright( String copyright ) 
    {
        this.copyright = copyright;
    }

    public String getNotice() 
    {
        return this.notice;
    }
    
    public void setNotice( String notice ) 
    {
        this.notice = notice;
    }

    public String getComment() 
    {
        return this.comment;
    }
    
    public void setComment( String comment ) 
    {
        this.comment = comment;
    }

    public String[] getContributors() 
    {
        return this.contributors;
    }
    
    public void setContributors( String[] contributors ) 
    {
        this.contributors = contributors;
    }

    public AnyLicenseInfo getConcludedLicense() 
    {
        return this.concludedLicense;
    }
    
    public void setConcludedLicense( AnyLicenseInfo license ) 
    {
        this.concludedLicense = license;
    }

    public String getLicenseComment() 
    {
        return this.licenseComment;
    }
    
    public void setLicenseComment( String licenseComment ) 
    {
        this.licenseComment = licenseComment;
    }
    
    

    /**
     * @return the snippets
     */
    public List getSnippets()
    {
        return snippets;
    }

    /**
     * @param snippets the snippets to set
     */
    public void setSnippets( List snippets )
    {
        this.snippets = snippets;
    }

    /**
     * Primarily for debugging purposes.  Dump all the field information to the log Info
     * @param log
     */
    public void logInfo( Log log )
    {
        log.debug( "Default File Comment: "+getComment() );
        log.debug( "Default File Copyright: "+getCopyright() );
        log.debug( "Default File License Comment: "+getLicenseComment() );
        log.debug( "Default File Notice: "+getNotice() );
        log.debug( "Default File Concluded License: "+getConcludedLicense().toString() );
        log.debug( "Default File Declared License: "+getDeclaredLicense().toString() );
        String[] contributors = getContributors();
        if ( contributors != null ) 
        {
            for ( int i = 0; i < contributors.length; i++ ) 
            {
                log.debug( "Default File Contributors: "+contributors[i] );
            }
        }
        if (this.snippets != null) {
            for ( SnippetInfo snippet:snippets ) {
                snippet.logInfo( log );
            }
        }
    }
}