buildframework/helium/sf/java/antdata/src/com/nokia/helium/ant/data/PropertyCommentMeta.java
author wbernard
Fri, 13 Aug 2010 14:59:05 +0300
changeset 628 7c4a911dc066
parent 587 85df38eb4012
permissions -rw-r--r--
helium_11.0.0-e00f171ca185
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     1
/*
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     2
 * Copyright (c) 2007-2008 Nokia Corporation and/or its subsidiary(-ies).
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     3
 * All rights reserved.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     4
 * This component and the accompanying materials are made available
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     5
 * under the terms of the License "Eclipse Public License v1.0"
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     6
 * which accompanies this distribution, and is available
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     7
 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     8
 *
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     9
 * Initial Contributors:
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    10
 * Nokia Corporation - initial contribution.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    11
 *
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    12
 * Contributors:
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    13
 *
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    14
 * Description: 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    15
 *
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    16
 */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    17
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    18
package com.nokia.helium.ant.data;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    19
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    20
import org.dom4j.Comment;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    21
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    22
/**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    23
 * Meta object for a property that is defined entirely by a comment.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    24
 */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    25
public class PropertyCommentMeta extends CommentMeta {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    26
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    27
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    28
     * Constructor.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    29
     * 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    30
     * @param parent The parent meta object.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    31
     * @param propertyNode XML node representing the comment.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    32
     */
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    33
    public PropertyCommentMeta(AntObjectMeta parent, Comment comment) {
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    34
        super(parent, comment);
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    35
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    36
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    37
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    38
     * Returns the property name as it is defined at the top of the comment
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    39
     * block for that property.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    40
     */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    41
    public String getName() {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    42
        return getComment().getObjectName();
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    43
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    44
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    45
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    46
     * There is no default value for properties defined only by comments.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    47
     */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    48
    public String getDefaultValue() {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    49
        return "";
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    50
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    51
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    52
    public String getType() {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    53
        return getComment().getTagValue("type", PropertyMeta.DEFAULT_TYPE);
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    54
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    55
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    56
    public String getEditable() {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    57
        return getComment().getTagValue("editable", PropertyMeta.DEFAULT_EDITABLE);
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    58
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    59
}