ComponentPort.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.airavata.workflow.model.component;

import org.apache.airavata.workflow.model.graph.Port;

public abstract class ComponentPort {

    protected String name;

    protected String description;

    /**
     * Constructs a ComponentPort.
     * 
     */
    protected ComponentPort() {
        // Do nothing
    }

    /**
     * Constructs a ComponentPort.
     * 
     * @param name
     */
    protected ComponentPort(String name) {
        this.name = name;
    }

    /**
     * Sets the name of the component.
     * 
     * @param name
     *            The name
     */
    public void setName(String name) {
        this.name = name;
    }

    /**
     * Returns the name of the component.
     * 
     * @return The name of the component
     */
    public String getName() {
        return this.name;
    }

    /**
     * Sets the description of the component.
     * 
     * @param description
     *            The description
     */
    public void setDescription(String description) {
        this.description = description;
    }

    /**
     * Returns the description of the component.
     * 
     * @return The description of the component
     */
    public String getDescription() {
        if (this.description == null) {
            this.description = "";
        }
        return this.description;
    }

    /**
     * @return The port created.
     */
    public abstract Port createPort();
}