Coverage Report

Coverage Report - org.argouml.uml.generator.GeneratorHelper

Classes in this File

Line Coverage

Branch Coverage

Complexity

GeneratorHelper

0/16

0/4

1.429

 /* $Id: GeneratorHelper.java 17868 2010-01-12 20:47:51Z 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) 2005-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.uml.generator;
 
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.List;
 
 import javax.swing.Icon;
 
 /**
  * Provides some utility methods for code generation.
  *
  * @author Daniele Tamino
  */
 public final class GeneratorHelper {
     /**
      * The constructor.
      */
     private GeneratorHelper() {
     }
 
     /**
      * Generate code for one or more elements in a given language.
      * @param lang The language to use.
      * @param elements The elements to generate code for.
      * @param deps Whether to generate dependency too.
      * @return A collection of SourceUnit objects. The collection may be empty
      * if no file is generated.
      */
     public static Collection generate(
             Language lang, Collection elements, boolean deps) {
         CodeGenerator gen =
             GeneratorManager.getInstance().getGenerator(lang);
         if (gen != null) {
             return gen.generate(elements, deps);
         }
         return new ArrayList(); // empty list
     }
 
     /**
      * Generate code for a single element.
      * @param lang The language to use.
      * @param elem The element to generate code for.
      * @param deps Whether to generate dependency too.
      * @return A collection of SourceUnit objects. The collection may be empty
      * if no file is generated.
      */
     public static Collection generate(
             Language lang, Object elem, boolean deps) {
         List list = new ArrayList();
         list.add(elem);
         return generate(lang, list, deps);
     }
 
     /**
      * Creates a new Language only if one with the same name doesn't already
      * exist in GeneratorManager, in which case that one is returned.
      * @param theName The name of the language.
      * @param theTitle A string representing the language for display.
      * @param theIcon An icon for the language.
      * @return The Language object found or created.
      */
     public static Language makeLanguage(String theName, String theTitle,
             Icon theIcon) {
         Language lang;
         lang = GeneratorManager.getInstance().findLanguage(theName);
         if (lang == null) {
             lang = new Language(theName, theTitle, theIcon);
         }
         return lang;
     }
 
     /**
      * Creates a language with no icon.
      * @see #makeLanguage(String, String, Icon)
      * @param theName The name of the language.
      * @param theTitle A string representing the language for display.
      * @return The Language object found or created.
      */
     public static Language makeLanguage(String theName, String theTitle) {
         return makeLanguage(theName, theTitle, null);
     }
 
     /**
      * Creates a language with title equal to the name.
      * @see #makeLanguage(String, String, Icon)
      * @param theName The name of the language.
      * @param theIcon An icon for the language.
      * @return The Language object found or created.
      */
     public static Language makeLanguage(String theName, Icon theIcon) {
         return makeLanguage(theName, theName, theIcon);
     }
 
     /**
      * Creates a language with title equal to the name and no icon.
      * @see #makeLanguage(String, String, Icon)
      * @param theName The name of the language.
      * @return The Language object found or created.
      */
     public static Language makeLanguage(String theName) {
         return makeLanguage(theName, theName, null);
     }
 
 }

1		/* $Id: GeneratorHelper.java 17868 2010-01-12 20:47:51Z 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) 2005-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.uml.generator;
40
41		import java.util.ArrayList;
42		import java.util.Collection;
43		import java.util.List;
44
45		import javax.swing.Icon;
46
47		/**
48		* Provides some utility methods for code generation.
49		*
50		* @author Daniele Tamino
51		*/
52		public final class GeneratorHelper {
53		/**
54		* The constructor.
55		*/
56	0	private GeneratorHelper() {
57	0	}
58
59		/**
60		* Generate code for one or more elements in a given language.
61		* @param lang The language to use.
62		* @param elements The elements to generate code for.
63		* @param deps Whether to generate dependency too.
64		* @return A collection of SourceUnit objects. The collection may be empty
65		* if no file is generated.
66		*/
67		public static Collection generate(
68		Language lang, Collection elements, boolean deps) {
69	0	CodeGenerator gen =
70		GeneratorManager.getInstance().getGenerator(lang);
71	0	if (gen != null) {
72	0	return gen.generate(elements, deps);
73		}
74	0	return new ArrayList(); // empty list
75		}
76
77		/**
78		* Generate code for a single element.
79		* @param lang The language to use.
80		* @param elem The element to generate code for.
81		* @param deps Whether to generate dependency too.
82		* @return A collection of SourceUnit objects. The collection may be empty
83		* if no file is generated.
84		*/
85		public static Collection generate(
86		Language lang, Object elem, boolean deps) {
87	0	List list = new ArrayList();
88	0	list.add(elem);
89	0	return generate(lang, list, deps);
90		}
91
92		/**
93		* Creates a new Language only if one with the same name doesn't already
94		* exist in GeneratorManager, in which case that one is returned.
95		* @param theName The name of the language.
96		* @param theTitle A string representing the language for display.
97		* @param theIcon An icon for the language.
98		* @return The Language object found or created.
99		*/
100		public static Language makeLanguage(String theName, String theTitle,
101		Icon theIcon) {
102		Language lang;
103	0	lang = GeneratorManager.getInstance().findLanguage(theName);
104	0	if (lang == null) {
105	0	lang = new Language(theName, theTitle, theIcon);
106		}
107	0	return lang;
108		}
109
110		/**
111		* Creates a language with no icon.
112		* @see #makeLanguage(String, String, Icon)
113		* @param theName The name of the language.
114		* @param theTitle A string representing the language for display.
115		* @return The Language object found or created.
116		*/
117		public static Language makeLanguage(String theName, String theTitle) {
118	0	return makeLanguage(theName, theTitle, null);
119		}
120
121		/**
122		* Creates a language with title equal to the name.
123		* @see #makeLanguage(String, String, Icon)
124		* @param theName The name of the language.
125		* @param theIcon An icon for the language.
126		* @return The Language object found or created.
127		*/
128		public static Language makeLanguage(String theName, Icon theIcon) {
129	0	return makeLanguage(theName, theName, theIcon);
130		}
131
132		/**
133		* Creates a language with title equal to the name and no icon.
134		* @see #makeLanguage(String, String, Icon)
135		* @param theName The name of the language.
136		* @return The Language object found or created.
137		*/
138		public static Language makeLanguage(String theName) {
139	0	return makeLanguage(theName, theName, null);
140		}
141
142		}