blob: 17491fa7811e1951358b96b89d0655b66785f98c (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
/*****************************************************************************
* Copyright (c) 2013 CEA LIST.
*
* 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:
* Saadia Dhouib (CEA LIST) saadia.dhouib@cea.fr - Initial API and implementation
*****************************************************************************/
package org.eclipse.papyrus.robotml.deployment.dialog;
import org.eclipse.uml2.uml.Comment;
import org.eclipse.uml2.uml.Element;
public class Description {
/**
* Return a description of an element. By default search comments that are
* owned by this elements owner (e.g. the class, if we search for a description of a property or the owning package,
* if we search for a description of a class)
*
* @param element
* the element for which to obtain a description
* @return the description of the element
*/
public static String getDescription(Element element) {
return getDescription(element.getOwner(), element);
}
/**
* Convenience function: Return a description of an element. It will delegate to
* default getDescription, but returns a user specified text, if a description is
* not available in the model.
*
* @param element
* @param unavailable
* The text that is return, if no description is available
* @return
*/
public static String getDescription(Element element, String unavailable) {
String description = getDescription(element);
if (description != null) {
return description;
}
else {
return unavailable;
}
}
/**
* Return a description or implementation description of an element, i.e. the
* first owned comment that annotated the passed element
*
* @param the
* owner of the comment
* the element for which to obtain a description
* @param annotated
* element
* the element for which to obtain a description
* @return the description of the element
*/
public static String getDescription(Element owner, Element annotatedElement) {
if (owner == null) {
return null;
}
// loop over all owned comments, check those that begins with
// "description"
for (Comment comment : owner.getOwnedComments()) {
// identify "right" comment via annotated element ref (to a specific
// class of the BasicCalls library) instead?
if (comment.getAnnotatedElements().contains(annotatedElement)) {
return comment.getBody();
}
}
return "not available";
}
}
|
