Coverage Report

Coverage Report - org.argouml.notation.NotationName

Classes in this File

 /* $Id: NotationName.java 17825 2010-01-12 18:49:29Z linus $
  *****************************************************************************
  * Copyright (c) 2009 Contributors - see below
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
  * which accompanies this distribution, and is available at
  * http://www.eclipse.org/legal/epl-v10.html
  *
  * Contributors:
  *    mvw
  *****************************************************************************
  *
  * Some portions of this file was previously release using the BSD License:
  */
 
 // Copyright (c) 1996-2006 The Regents of the University of California. All
 // Rights Reserved. Permission to use, copy, modify, and distribute this
 // software and its documentation without fee, and without a written
 // agreement is hereby granted, provided that the above copyright notice
 // and this paragraph appear in all copies.  This software program and
 // documentation are copyrighted by The Regents of the University of
 // California. The software program and documentation are supplied "AS
 // IS", without any accompanying services from The Regents. The Regents
 // does not warrant that the operation of the program will be
 // uninterrupted or error-free. The end-user understands that the program
 // was developed for research purposes and is advised not to rely
 // exclusively on the program for any reason.  IN NO EVENT SHALL THE
 // UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
 // SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
 // ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
 // THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
 // SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
 // WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
 // PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
 // CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
 // UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 
 package org.argouml.notation;
 
 import javax.swing.Icon;
 
 /**
  * Encapsulates specific attributes about a notation.
  *
  * @author Thierry Lach
  * @since  ARGO0.9.4
  */
 public interface NotationName {
 
     /**
      * Returns the name of the language.
      *
      * @return the language name.
      */
     String getName();
 
     /**
      * Returns the version of the language if applicable, otherwise
      * <code>null</code>.
      *
      * @return The language version or <code>null</code>.
      */
     String getVersion();
 
     /**
      * Returns a textual title for the notation. The name and version.
      *
      * @return a title for the language.
      */
     String getTitle();
 
     /**
      * Returns an icon for the notation, or <code>null</code> if no icon
      * is available.
      *
      * @return An {@link Icon} for the language or <code>null</code>.
      */
     Icon getIcon();
 
     /**
      * Returns the text string stored in the configuration
      * for this notation.  This string is used to determine
      * notation equality in {@link #sameNotationAs(NotationName)}.<p>
      *
      * This should incorporate both the name and the version if one
      * exists.
      *
      * @return the value for this notation to be stored in the configuration.
      */
     String getConfigurationValue();
 
     /**
      * Ease-of-use helper for usage in swing.
      * Usually, it is equal to <code>getConfigurationValue()</code>.
      *
      * @return a String representation of the notation name.
      */
     String toString();
 
     /**
      * Ease-of-use helper to determine
      * if this notation is the same as another.
      * This must be equivalent to
      * <code>getConfigurationValue().equals(nn.getConfigurationValue())</code>
      *
      * @param notationName to compare
      * @return boolean indicating equality or inequality.
      */
     boolean sameNotationAs(NotationName notationName);
 }

1		/* $Id: NotationName.java 17825 2010-01-12 18:49:29Z linus $
2		*****************************************************************************
3		* Copyright (c) 2009 Contributors - see below
4		* All rights reserved. This program and the accompanying materials
5		* are made available under the terms of the Eclipse Public License v1.0
6		* which accompanies this distribution, and is available at
7		* http://www.eclipse.org/legal/epl-v10.html
8		*
9		* Contributors:
10		* mvw
11		*****************************************************************************
12		*
13		* Some portions of this file was previously release using the BSD License:
14		*/
15
16		// Copyright (c) 1996-2006 The Regents of the University of California. All
17		// Rights Reserved. Permission to use, copy, modify, and distribute this
18		// software and its documentation without fee, and without a written
19		// agreement is hereby granted, provided that the above copyright notice
20		// and this paragraph appear in all copies. This software program and
21		// documentation are copyrighted by The Regents of the University of
22		// California. The software program and documentation are supplied "AS
23		// IS", without any accompanying services from The Regents. The Regents
24		// does not warrant that the operation of the program will be
25		// uninterrupted or error-free. The end-user understands that the program
26		// was developed for research purposes and is advised not to rely
27		// exclusively on the program for any reason. IN NO EVENT SHALL THE
28		// UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
29		// SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
30		// ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
31		// THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
32		// SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
33		// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
34		// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
35		// PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
36		// CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
37		// UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
38
39		package org.argouml.notation;
40
41		import javax.swing.Icon;
42
43		/**
44		* Encapsulates specific attributes about a notation.
45		*
46		* @author Thierry Lach
47		* @since ARGO0.9.4
48		*/
49		public interface NotationName {
50
51		/**
52		* Returns the name of the language.
53		*
54		* @return the language name.
55		*/
56		String getName();
57
58		/**
59		* Returns the version of the language if applicable, otherwise
60		* <code>null</code>.
61		*
62		* @return The language version or <code>null</code>.
63		*/
64		String getVersion();
65
66		/**
67		* Returns a textual title for the notation. The name and version.
68		*
69		* @return a title for the language.
70		*/
71		String getTitle();
72
73		/**
74		* Returns an icon for the notation, or <code>null</code> if no icon
75		* is available.
76		*
77		* @return An {@link Icon} for the language or <code>null</code>.
78		*/
79		Icon getIcon();
80
81		/**
82		* Returns the text string stored in the configuration
83		* for this notation. This string is used to determine
84		* notation equality in {@link #sameNotationAs(NotationName)}.<p>
85		*
86		* This should incorporate both the name and the version if one
87		* exists.
88		*
89		* @return the value for this notation to be stored in the configuration.
90		*/
91		String getConfigurationValue();
92
93		/**
94		* Ease-of-use helper for usage in swing.
95		* Usually, it is equal to <code>getConfigurationValue()</code>.
96		*
97		* @return a String representation of the notation name.
98		*/
99		String toString();
100
101		/**
102		* Ease-of-use helper to determine
103		* if this notation is the same as another.
104		* This must be equivalent to
105		* <code>getConfigurationValue().equals(nn.getConfigurationValue())</code>
106		*
107		* @param notationName to compare
108		* @return boolean indicating equality or inequality.
109		*/
110		boolean sameNotationAs(NotationName notationName);
111		}