(file) Return to CIMName.h CVS log (file) (dir) Up to [Pegasus] / pegasus / src / Pegasus / Common

Diff for /pegasus/src/Pegasus/Common/CIMName.h between version 1.20 and 1.27

version 1.20, 2002/09/13 21:40:42 version 1.27, 2004/06/15 18:38:24
Line 1 
Line 1 
 //%/////////////////////////////////////////////////////////////////////////////  //%2003////////////////////////////////////////////////////////////////////////
 // //
 // Copyright (c) 2000, 2001, 2002 BMC Software, Hewlett-Packard Company, IBM,  // Copyright (c) 2000, 2001, 2002  BMC Software, Hewlett-Packard Development
 // The Open Group, Tivoli Systems  // Company, L. P., IBM Corp., The Open Group, Tivoli Systems.
   // Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L. P.;
   // IBM Corp.; EMC Corporation, The Open Group.
 // //
 // Permission is hereby granted, free of charge, to any person obtaining a copy // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files (the "Software"), to // of this software and associated documentation files (the "Software"), to
Line 53 
Line 55 
     CIM names. A CIM name must match the following regular     CIM names. A CIM name must match the following regular
     expression:     expression:
     <PRE>     <PRE>
   
         [A-Z-a-z_][A-Za-z_0-9]*         [A-Z-a-z_][A-Za-z_0-9]*
     </PRE>     </PRE>
       <B>Examples:</B>
       <ul>
       <li>name - legal name
       <li>Type - legal name
       <li>3types - Illegal CIMName.
       </ul>
       The CIMName object includes the attribute Null which is required
       by the DMTF operations definitions.  Note that this and the regular
       expression limits on CIMName are what separate this from the String
       class. This allows the names in CIM operations such as getClass to
       provide pattern matching tests for the classname parameter as well as
       separate the concept of empty from Null.
  
     Notice that the definition of a name is the same as C, C++,  
     and Java.  
 */ */
 class PEGASUS_COMMON_LINKAGE CIMName class PEGASUS_COMMON_LINKAGE CIMName
 { {
 public: public:
  
       /** Default constructor (sets isNull to true).
       */
     CIMName();     CIMName();
   
           /** Constructor creates a new CIMName object from
               the String provided as input. The String must
               be a legal name.
               @param String defining the CIMName
               @Exception InvalidNameException if the input String is
               not a legal CIMName
       */
     CIMName(const String& name);     CIMName(const String& name);
       /**
           Constructor creates a new CIMName object from
                           the String provided as input. The String must
                           be a legal name.
                           @param char* defining the CIMName text.
                           @Exception InvalidNameException if the input String is
                           not a legal CIMName
           */
     CIMName(const char* name);     CIMName(const char* name);
  
       /** Copy Constructor for CIMName object
           */
     CIMName& operator=(const CIMName& name);     CIMName& operator=(const CIMName& name);
       /** Copy constructor String object. Allows copying
               String value into a CIMName.
               @param String to be copied into CIMName
               @exception InvalidNameException if the input String
               is not a legal CIMName
               <pre>
                           CIMName n;
                           String type = "type";
                           n = type;
               </pre>
           */
     CIMName& operator=(const String& name);     CIMName& operator=(const String& name);
  
 #ifndef PEGASUS_REMOVE_DEPRECATED      /** Extracts the String value of the CIMName
     CIMName& operator=(const char* name);              from the CIMName object.
 #endif              @return String containing the name.
               <pre>
                           CIMName n("name");
                           String s = n.getString();
               </pre>
           */
     const String& getString() const;     const String& getString() const;
  
 #ifndef PEGASUS_REMOVE_DEPRECATED      /** Tests the CIMName for NULL attribute.
     operator String() const;              @return true if Null or false if not Null.
 #endif              <pre>
                           CIMName n;
                           assert(n.isNull());
                           n = "name";
                           assert(!n.isNull());
               </pre>
           */
     Boolean isNull() const;     Boolean isNull() const;
  
       /** Clears the CIMName and sets it to Null.
               <pre>
                   CIMMame n("name");
                   n.clear();
                   assert(n.isNull());
               </pre>
           */
     void clear();     void clear();
  
     /** equal - Compares two names.      /** Compares the CIMName object against another CIMName object for equality.
         @return Return true if the two names are equal. CIM names are              @param CIMName to compare.
         case insensitive and so is this method.                  @return true if the name passed is equal to the name in this
           class. CIM names are case insensitive and so is this method.
               <pre>
               CIMName n1 = "name";
               CIMName n2 = "InstanceID";
               if( n1.equal(n2) )
                       ...                                         // Should never get here
               else
                       ...
               </pre>
     */     */
     Boolean equal(const CIMName& name) const;     Boolean equal(const CIMName& name) const;
  
     //  ATTN: Define what is legal      /** Determines if the name string input is legal as
     /** legal - Determine if the name string input is legal as                  defined in the CIMName class definition. This is a static
         defnined in the CIMName class definition                  method used to test String values to determine if they are
         @param - String to test                  legal names.
         @return Returns true if the given name is legal.                  @param name String to test for legality.
                   @return true if the given name is legal, false otherwise.
           <pre>
               assert(CIMName::legal("name"));
               assert(!CIMName::legal("3types"));
           </pre>
     */     */
     static Boolean legal(const String& name) throw();      static Boolean legal(const String& name);
  
 private: private:
     String cimName;     String cimName;
Line 123 
Line 195 
     <p>     <p>
     A CIM namespace name must match the following expression:     A CIM namespace name must match the following expression:
     <PRE>     <PRE>
         <CIMName>[/<CIMName>]...          &lt;CIMName&gt;[ / &lt;CIMName&gt; ]*
     </PRE>     </PRE>
       </p>
       <B>Examples</B>
       <UL>
       <LI>root
       <LI>root/test
       </UL>
       NOTE: Pegasus uses namespaces starting with the top level name (ex. root).  It does
       not use the form /root/test with a leading slash.  The legal() test method in this class
       allows that form as a legal entity however.
 */ */
 class PEGASUS_COMMON_LINKAGE CIMNamespaceName class PEGASUS_COMMON_LINKAGE CIMNamespaceName
 { {
 public: public:
  
       /** Default constructor sets object Null. The Null state
               indicates that there is no name assigned to this object.
               The Null state can be tested with the isNull() method and
               set with the clear() method.
           */
     CIMNamespaceName();     CIMNamespaceName();
   
       /** Constructor builds namespace from input String.
               The String input must be a legal namespace name.
               @param String from which the namespace object is built.
               This must be a legal namespace name.
               @exeception InvalidNamespaceName exception thrown if
               the namespace name input is illegal.
           */
     CIMNamespaceName(const String& name);     CIMNamespaceName(const String& name);
   
       /** Constructor builds namespace from input char*.
               The String input must be a legal namespace name.
               @param char* from which the namespace object is built.
               This must be a legal namespace name.
               @exeception InvalidNamespaceName exception thrown if
               the namespace name input parameter is illegal.
           */
     CIMNamespaceName(const char* name);     CIMNamespaceName(const char* name);
  
       /** Assign one namespace object to another.
                   @param CIMNamespaceName to assign to the object.
           */
     CIMNamespaceName& operator=(const CIMNamespaceName& name);     CIMNamespaceName& operator=(const CIMNamespaceName& name);
     CIMNamespaceName& operator=(const String& name);  
  
 #ifndef PEGASUS_REMOVE_DEPRECATED      /** Assign a String object to a CIMNamespaceName object.
     CIMNamespaceName& operator=(const char* name);                  @param CIMNamespaceName to assign
 #endif                  @exeception InvalidNamespaceName exception thrown if
                   the namespace name input parameter is illegal.
               <pre>
                           String s = "root/test";
                           CIMNamespacename ns;
                           ns = s;
               </pre>
           */
       CIMNamespaceName& operator=(const String& name);
  
       /** Extracts the String value of the CIMNamespaceName
               from the object.
               @return String containing the name.
               <pre>
                           CIMNamespaceName ns("root/test");
                           String s = ns.getString();
               </pre>
           */
     const String& getString() const;     const String& getString() const;
  
 #ifndef PEGASUS_REMOVE_DEPRECATED      /** Tests the CIMNamespaceName for NULL attribute. Returns
     operator String() const;              true if Null.  New objects without parameter and objects
 #endif              set with clear() are Null.  When a name is set into the
               object is is set to nonnull.  When the object is Null, it
               returns empty string.
               @return true if Null or false if not Null.
               <pre>
                           CIMName n;
                           assert(n.isNull());
                           n = "name";
                           assert(!n.isNull());
               </pre>
           */
     Boolean isNull() const;     Boolean isNull() const;
  
       /** Clears the CIMNamespaceName and sets it to Null. A Null
               object contains no name so that accessing it with getString
               should return an empty String
               <pre>
                           CIMMamespaceName ns("root/test");
                           ns.clear();
                           assert(ns.isNull());
               </pre>
           */
     void clear();     void clear();
  
     /** equal - Compares two names.      /** Compares two CIMNamespace objects for equality.
         @return Return true if the two names are equal. CIM names are                  @return true if the name passed is equal to the name in this
         case insensitive and so is this method.          class. CIM names are case insensitive and so is this method.
                   <pre>
                   CIMMamespaceName ns("root/test");
                   CIMMamespaceName ns1("root/test");
                   assert( ns.equal(ns1);
               </pre>
     */     */
     Boolean equal(const CIMNamespaceName& name) const;     Boolean equal(const CIMNamespaceName& name) const;
  
     //  ATTN: Define what is legal      /** Determines if the name string input is legal as
     /** legal - Determine if the name string input is legal as          defined in the CIMNamespaceName class definition.
         defnined in the CIMNamespaceName class definition          @param name String to test for legality.
         @param - String to test          @return true if the given name is legal, false otherwise.
         @return Returns true if the given name is legal.          <pre>
                   assert(CIMNamespaceName::legal("root/test"));
           </pre>
     */     */
     static Boolean legal(const String& name) throw();      static Boolean legal(const String& name);
  
 private: private:
     String cimNamespaceName;     String cimNamespaceName;

Legend:
Removed from v.1.20  
changed lines
  Added in v.1.27
No CVS admin address has been configured
 Powered by
ViewCVS 0.9.2