src/main/java/org/apache/felix/scrplugin/om/Property.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.felix.scrplugin.om;

import org.apache.felix.scrplugin.Constants;
import org.apache.felix.scrplugin.IssueLog;
import org.apache.felix.scrplugin.tags.JavaTag;

/**
 * <code>Property.java</code>...
 *
 */
public class Property extends AbstractObject {

    protected String name;
    protected String value;
    protected String type;
    protected String[] multiValue;

    protected boolean isPrivate;
    protected String label;
    protected String description;
    protected String cardinality;

    /**
     * Default constructor.
     */
    public Property() {
        this(null);
    }

    /**
     * Constructor from java source.
     */
    public Property(JavaTag t) {
        super(t);
    }

    public String getName() {
        return this.name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getValue() {
        return this.value;
    }

    public void setValue(String value) {
        this.value = value;
        this.multiValue = null;
    }

    public String getType() {
        return this.type;
    }

    public void setType(String type) {
        this.type = type;
    }

    public String[] getMultiValue() {
        return this.multiValue;
    }

    public void setMultiValue(String[] values) {
        this.multiValue = values;
        this.value = null;
    }

    /**
     * Validate the property.
     * If errors occur a message is added to the issues list,
     * warnings can be added to the warnings list.
     */
    public void validate(final int specVersion, final IssueLog iLog) {
        if ( name == null || name.trim().length() == 0 ) {
            iLog.addError(this.getMessage("Property name can not be empty."));
        }
        if ( type != null ) {
            if ( !type.equals(Constants.PROPERTY_TYPE_BOOLEAN)
                 && !type.equals(Constants.PROPERTY_TYPE_BYTE )
                 && !type.equals(Constants.PROPERTY_TYPE_CHAR )
                 && !type.equals(Constants.PROPERTY_TYPE_CHAR_1_1 )
                 && !type.equals(Constants.PROPERTY_TYPE_DOUBLE )
                 && !type.equals(Constants.PROPERTY_TYPE_FLOAT )
                 && !type.equals(Constants.PROPERTY_TYPE_INTEGER )
                 && !type.equals(Constants.PROPERTY_TYPE_LONG )
                 && !type.equals(Constants.PROPERTY_TYPE_STRING )
                 && !type.equals(Constants.PROPERTY_TYPE_SHORT ) ) {
                iLog.addError(this.getMessage("Property " + name + " has unknown type: " + type));
            }
            // now check for old and new char
            if ( specVersion == Constants.VERSION_1_0 && type.equals(Constants.PROPERTY_TYPE_CHAR_1_1) ) {
                type = Constants.PROPERTY_TYPE_CHAR;
            }
            if ( specVersion == Constants.VERSION_1_1 && type.equals(Constants.PROPERTY_TYPE_CHAR) ) {
                type = Constants.PROPERTY_TYPE_CHAR_1_1;
            }
        }
        // TODO might want to check value
    }

    public boolean isPrivate() {
        return isPrivate;
    }

    public void setPrivate(boolean isPrivate) {
        this.isPrivate = isPrivate;
    }

    public String getLabel() {
        return label;
    }

    public void setLabel(String label) {
        this.label = label;
    }

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }

    public String getCardinality() {
        return cardinality;
    }

    public void setCardinality(String cardinality) {
        this.cardinality = cardinality;
    }

}