summaryrefslogtreecommitdiff
path: root/src/plugins/common/src/com/motorola/studio/android/model/manifest/dom/AbstractIconLabelNameNode.java
blob: 3fa72b9d701bb50cbff25e3033cd9b0996d5f383 (plain)
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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
/*
* Copyright (C) 2012 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*      http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.motorola.studio.android.model.manifest.dom;

import java.util.Map;

import org.eclipse.core.runtime.Assert;

/**
 * Abstract class to be used to create nodes that contains the properties 
 * "icon", "label" and "name"
 */
public abstract class AbstractIconLabelNameNode extends AndroidManifestNode implements
        IAndroidManifestProperties
{
    static
    {
        // Adds the node properties to the list
        defaultProperties.add(PROP_ICON);
        defaultProperties.add(PROP_LABEL);
        defaultProperties.add(PROP_NAME);
    }

    /**
     * The icon property
     */
    protected String propIcon = null;

    /**
     * The label property
     */
    protected String propLabel = null;

    /**
     * The name property
     */
    protected String propName = null;

    /**
     * Default constructor
     * 
     * @param name The name property. It must not be null.
     * @param newProperties The new properties that are accepted by the child class
     */
    protected AbstractIconLabelNameNode(String name)
    {
        Assert.isLegal(name != null);

        this.propName = name;
    }

    /* (non-Javadoc)
     * @see com.motorola.studio.android.model.manifest.dom.AndroidManifestNode#isNodeValid()
     */
    @Override
    protected boolean isNodeValid()
    {
        return propName.trim().length() > 0;
    }

    /* (non-Javadoc)
     * @see com.motorola.studio.android.model.manifest.dom.AndroidManifestNode#getNodeProperties()
     */
    @Override
    public Map<String, String> getNodeProperties()
    {
        properties.clear();

        if ((propName != null) && (propName.trim().length() > 0))
        {
            properties.put(PROP_NAME, propName);
        }

        if ((propIcon != null) && (propIcon.trim().length() > 0))
        {
            properties.put(PROP_ICON, propIcon);
        }

        if ((propLabel != null) && (propLabel.trim().length() > 0))
        {
            properties.put(PROP_LABEL, propLabel);
        }

        addAdditionalProperties();

        return properties;
    }

    /**
     * Adds the additional properties to the properties variable
     */
    protected abstract void addAdditionalProperties();

    /**
     * Gets the icon property value
     * 
     * @return the icon property value
     */
    public String getIcon()
    {
        return propIcon;
    }

    /**
     * Sets the icon property value. Set it to null to remove it.
     * 
     * @param icon the icon property value
     */
    public void setIcon(String icon)
    {
        this.propIcon = icon;
    }

    /**
     * Gets the label property value
     * 
     * @return the label property value
     */
    public String getLabel()
    {
        return propLabel;
    }

    /**
     * Sets the label property value. Set it to null to remove it.
     * 
     * @param label the label property value
     */
    public void setLabel(String label)
    {
        this.propLabel = label;
    }

    /**
     * Gets the name property value
     * 
     * @return the name property value
     */
    public String getName()
    {
        return propName;
    }

    /**
     * Sets the name property value. It must not be set to null.
     * 
     * @param name the name property value
     */
    public void setName(String name)
    {
        Assert.isLegal(name != null);
        this.propName = name;
    }
}