Coverage Report

Coverage Report - org.argouml.ui.explorer.WeakExplorerNode

Classes in this File

 /* $Id: WeakExplorerNode.java 17843 2010-01-12 19:23: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:
  *    linus
  *****************************************************************************
  *
  * Some portions of this file was previously release using the BSD License:
  */
 
 // Copyright (c) 2004-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.ui.explorer;
 
 /**
  * Interface for adding weak nodes to the explorer, in this case nodes that
  * can yield to nodes already in the explorer. This may typically look like:
  *
  * <pre>
  * public class SomeNode implements WeakExplorerNode {
  *     Object parent;
  *
  *     public SomeNode(Object parent) {
  *         this.parent = parent;
  *     }
  *
  *     public boolean subsumes(Object obj) {
  *         return obj instanceof SomeNode;
  *     }
  * }
  * </pre>
  *
  * About subsumption:
  * <ul>
  * <li>Weak nodes must not rely on that the Explorer preserves the oldest one.
  * <li>The Explorer will not check if several PerspectiveRules has returned
  *     nodes that subsume eachother. Thus it is up to the PerspectiveRules to
  *     make sure that they will not suggest nodes that subsume eachother.
  * <li>The Explorer assumes that they have done this, and can thus draw two
  *     conclusions:
  *     <ul>
  *     <li>If the same WeakExplorerNode instance is returned by any
  *         PerspectiveRule then it will not subsume any other WeakExplorerNode.
  *     <li>If a WeakExplorerNode has subsumed a new WeakExplorerNode then
  *         it will not subsume another (if it would, then those would be
  *         expected to subsume eachother and thus the PerspectiveRules has
  *         failed).
  *     </ul>
  * </ul>
  *
  * @author d00mst
  * @since 0.16.alpha1
  */
 public interface WeakExplorerNode {
 
     /**
      * This method is called by ExplorerTreeModel to check if this
      * WeakExplorerNode subsumes another WeakExplorerNode, ie if this
      * node should be preserved rather than adding the other node.<p>
      *
      * This relation should be reflexive, so that if <code>a</code>
      * is a WeakExplorerNode then <code>a.subsumes(a) == true</code>.<p>
      *
      * This relation should be symmetric, so that if a and b are
      * WeakExplorerNodes and <code>a.subsumes(b) == true</code> then
      * <code>b.subsumes(a) == true</code>.<p>
      *
      * This relation should be transitive, so that if a, b and c are
      * WeakExplorerNodes, <code>a.subsumes(b) == true</code> and
      * <code>b.subsumes(c) == true</code> then
      * <code>a.subsumes(c) == true</code>.<p>
      *
      * Note: While this means that only other WeakExplorerNodes can be
      * subsumed, the argument is still of Object type. This is just since
      * there is no particular point in getting a WeakExplorerNode reference,
      * you would either have to down-cast it further or wouldn't use it more
      * than as an Object pointer.
      *
      * @param obj another WeakExplorerNode
      * @return true if this node subsumes obj, otherwise false.
      */
     boolean subsumes(Object obj);
 }
 

1		/* $Id: WeakExplorerNode.java 17843 2010-01-12 19:23: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		* linus
11		*****************************************************************************
12		*
13		* Some portions of this file was previously release using the BSD License:
14		*/
15
16		// Copyright (c) 2004-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.ui.explorer;
40
41		/**
42		* Interface for adding weak nodes to the explorer, in this case nodes that
43		* can yield to nodes already in the explorer. This may typically look like:
44		*
45		* <pre>
46		* public class SomeNode implements WeakExplorerNode {
47		* Object parent;
48		*
49		* public SomeNode(Object parent) {
50		* this.parent = parent;
51		* }
52		*
53		* public boolean subsumes(Object obj) {
54		* return obj instanceof SomeNode;
55		* }
56		* }
57		* </pre>
58		*
59		* About subsumption:
60		* <ul>
61		* <li>Weak nodes must not rely on that the Explorer preserves the oldest one.
62		* <li>The Explorer will not check if several PerspectiveRules has returned
63		* nodes that subsume eachother. Thus it is up to the PerspectiveRules to
64		* make sure that they will not suggest nodes that subsume eachother.
65		* <li>The Explorer assumes that they have done this, and can thus draw two
66		* conclusions:
67		* <ul>
68		* <li>If the same WeakExplorerNode instance is returned by any
69		* PerspectiveRule then it will not subsume any other WeakExplorerNode.
70		* <li>If a WeakExplorerNode has subsumed a new WeakExplorerNode then
71		* it will not subsume another (if it would, then those would be
72		* expected to subsume eachother and thus the PerspectiveRules has
73		* failed).
74		* </ul>
75		* </ul>
76		*
77		* @author d00mst
78		* @since 0.16.alpha1
79		*/
80		public interface WeakExplorerNode {
81
82		/**
83		* This method is called by ExplorerTreeModel to check if this
84		* WeakExplorerNode subsumes another WeakExplorerNode, ie if this
85		* node should be preserved rather than adding the other node.<p>
86		*
87		* This relation should be reflexive, so that if <code>a</code>
88		* is a WeakExplorerNode then <code>a.subsumes(a) == true</code>.<p>
89		*
90		* This relation should be symmetric, so that if a and b are
91		* WeakExplorerNodes and <code>a.subsumes(b) == true</code> then
92		* <code>b.subsumes(a) == true</code>.<p>
93		*
94		* This relation should be transitive, so that if a, b and c are
95		* WeakExplorerNodes, <code>a.subsumes(b) == true</code> and
96		* <code>b.subsumes(c) == true</code> then
97		* <code>a.subsumes(c) == true</code>.<p>
98		*
99		* Note: While this means that only other WeakExplorerNodes can be
100		* subsumed, the argument is still of Object type. This is just since
101		* there is no particular point in getting a WeakExplorerNode reference,
102		* you would either have to down-cast it further or wouldn't use it more
103		* than as an Object pointer.
104		*
105		* @param obj another WeakExplorerNode
106		* @return true if this node subsumes obj, otherwise false.
107		*/
108		boolean subsumes(Object obj);
109		}
110