jadex.bridge.GlobalResourceIdentifier Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jadex-platform-bridge Show documentation

Jadex bridge is a base package for kernels and platforms, i.e., it is used by both and provides commonly used interfaces and classes for active components and their management.

There is a newer version: 4.0.267

Show newest version

/**
 * 
 */
package jadex.bridge;

import java.net.URI;

import jadex.bridge.service.annotation.Reference;

/**
 *  Default implementation for global resource identification.
 */
@Reference(local=true, remote=false)
public class GlobalResourceIdentifier implements IGlobalResourceIdentifier
{
	//-------- attributes --------
	
	/** The id. */
	protected String id;
	
	/** The URI. */
	protected URI uri;
	
	/** The version info. */
	protected String versioninfo;
	
	//-------- constructors --------

	/**
	 *  Create a resource identifier.
	 */
	public GlobalResourceIdentifier()
	{
		// bean constructor
	}
	
	/**
	 *  Create a resource identifier.
	 *  @param cid The platform identifier.
	 *  @param url The local URL.
	 */
	public GlobalResourceIdentifier(String id, URI url, String versioninfo)
	{
		if(id==null)
			throw new IllegalArgumentException("Id must not null.");
		
		this.id = id;
		this.uri = url;
		this.versioninfo = versioninfo;
	}
	
	//-------- methods --------
	
	/**
	 *  Get the resource id. E.g. in case of maven the global
	 *  coordinates in the form groupid:artifactid:version
	 *  @return The id. 
	 */
	public String getResourceId()
	{
		return id;
	}
	
	/**
	 *  todo: make struct to also allow containing
	 *  Get the url.
	 *  @return The resource url.
	 */
	public URI getRepositoryInfo()
	{
		return uri;
	}
	
	/**
	 *  Set the id.
	 *  @param id The id.
	 */
	public void setResourceId(String id)
	{
		this.id = id;
	}
	
	/**
	 *  Set the repository info.
	 *  @param info The info.
	 */
	public void setRepositoryInfo(URI uri)
	{
		this.uri = uri;
	}
	
	/**
	 *  Get the version info. Important in case
	 *  of snapshot versions, here the concrete
	 *  timestamp of the version is included.
	 *  @return The version info.
	 */
	public String getVersionInfo()
	{
		return versioninfo;
	}
	
	/**
	 *  Set the version info.
	 */
	public void setVersionInfo(String versioninfo)
	{
		this.versioninfo = versioninfo;
	}
	
	/**
	 *  Get the hashcode.
	 */
	public int hashCode()
	{
		return  31 + id.hashCode();
	}

	/**
	 *  Test if equals.
	 */
	public boolean equals(Object obj)
	{
		boolean ret = false;
		if(obj instanceof IGlobalResourceIdentifier)
		{
			IGlobalResourceIdentifier other = (IGlobalResourceIdentifier)obj;
			ret = other.getResourceId().equals(getResourceId());
		}
		return ret;
	}
	
	/**
	 *  Get a string representation of this object.
	 */
	public String	toString()
	{
		String ret = id;
		if(uri!=null)
			ret += " ("+uri+")";
		return ret;
	}
}