org.mitre.cpe.naming.util.CPEName Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cpe Show documentation

This project implements a series of specifications published by the National Institute of Standards and Technology. The specifications are collectively called CPE 2.3 and can be found here: http://csrc.nist.gov/publications/PubsNISTIRs.html

The newest version!

// Copyright (c) 2011, The MITRE Corporation
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without modification, are
// permitted provided that the following conditions are met:
//
//    * Redistributions of source code must retain the above copyright notice, this list
//      of conditions and the following disclaimer.
//    * Redistributions in binary form must reproduce the above copyright notice, this
//      list of conditions and the following disclaimer in the documentation and/or other
//      materials provided with the distribution.
//    * Neither the name of The MITRE Corporation nor the names of its contributors may be
//      used to endorse or promote products derived from this software without specific
//      prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
// OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
// SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
// OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
// HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
// TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
// EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package org.mitre.cpe.naming.util;

import org.mitre.cpe.common.WellFormedName;

/**
 * Represents a notional CPE Name unbound to a {@link WellFormedName}.
 * Implementations of this interface will track the unbound form of the CPE Name
 * enabling the bound form to be regenerated.
 * 
 * @author David Waltermire
 */
public interface CPEName {
	/**
	 * 
	 * @return {@link WellFormedName} representing the unbound CPE Name
	 */
	WellFormedName getWellFormedName();
	/**
	 * 
	 * @return the bound form of the associated {@link WellFormedName}
	 */
	String toString();
}