attribute.java

CmisJavaApi

/*
 * The contents of this file are subject to the Dyade Public License, 
 * as defined by the file DYADE_PUBLIC_LICENSE.TXT
 *
 * You may not use this file except in compliance with the License. You may
 * obtain a copy of the License on the Dyade web site (www.dyade.fr).
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
 * the specific terms governing rights and limitations under the License.
 *
 * The Original Code is CmisJava API, including the java package 
 * fr.dyade.cmis, released September 5, 2000.
 *
 * The Initial Developer of the Original Code is Dyade. The Original Code and
 * portions created by Dyade are Copyright Bull and Copyright INRIA. 
 * All Rights Reserved.
 */

/*      Copyright 1996-2000 by Institut National de Recherche en Informatique 
 *                             et en Automatique (INRIA)
 *          All rights reserved.  See COPYRIGHT in top-level directory.
 *
 *      Authors: Laurent Andrey, Eric Dillon, Olivier Festor
 */
//---------------------------------------------------------------------------//
//
//  File:          Attribute.java
//  Project:	   Cmis over Java
//  Author(s):     Eric DILLON
//  Creation:      20.03.1998
//  Last modified: 09.04.1998
//
//---------------------------------------------------------------------------//
//---------------------------------------------------------------------------//
//  CVS Info
//---------------------------------------------------------------------------//
//
//  $Id: Attribute.java,v 1.2 2000/09/05 13:30:28 festor Exp $
//  $Source: /local/resedas/CVS-Repository/CmisJavaApi/src/fr/dyade/cmis/api/types/Attribute.java,v $

//---------------------------------------------------------------------------//
//  Todo
//---------------------------------------------------------------------------//
//

package fr.dyade.cmis.api.types;

/** ASN1 type for Attribute
  *    
  *  In X711 page 20 this type directly coded as a SEQUENCE { attribueId
  *  AttributeID, AttributeValue ANY DEFINED BY attributeId}.
  */
public class Attribute extends CMISType {
      /**
	*  Creates a new instance of Attribute given its <code>AttributeId</code> and its <code>Value</code>
	*  @param pName The <code>AttributeId</code> of the new <code>Attribute</code>
	*  @param pValue The <code>Value</code> of the new <code>Attribute</code>
	*/
      public Attribute( AttributeId pName, Value pValue) {
	 fId=pName;
	 fValue=pValue;
      }
      
      /**
	* Convenient constructor form AttributeId dotted notation and value.
	*/
      public Attribute( String pDottedFormOID, Value pValue ) {
	 this(new AttributeId(pDottedFormOID), pValue);
      }
      /**
	*   Returns a <code>String</code> representation of the <code>Attribute</code> for debugging purpose: 
	*      "<code>AttributeId = Value</code>"
	* @return The <code>String</code> representation of the <code>Attribute</code>
	*/
      public String toString(){
	 return fId.toString()+"="+ ((fValue!=null) ? fValue.toString():"**null value**");
      }
  
      /**
	*  Returns true if the <code>AttributeId</code> of the current <code>Attribute</code> is 
	*  <code>pAttributeId</code>
	*  @param pAttributeId The <code>AttributeId</code> to compare
	*  @return <code>true</code> if <code>Attribute</code> has the <code>pAttributeId</code> <code>AttributeId</code>
	*/
      public boolean isOfId(AttributeId pAttributeId){
	 return pAttributeId.equals(fId);
      }
      
      /**
	*   Returns the <code>Value</code> of the <code>Attribute</code>
	*  @return The <code>Attribute</code>'s <code>Value</code>
	*/
      public final Value getValue(){
	 return fValue;
      }

      /**
	*   Returns the <code>AttributeId</code> of the <code>Attribute</code>.
	*  @return The <code>Attribute</code>'s <code>AttributeId</code>.
	*/
      public final AttributeId getAttributeId(){
	 return fId;
      }
      
      private AttributeId fId=null;
      private Value fValue=null;
}