001    /**
002     * Licensed to the Apache Software Foundation (ASF) under one or more
003     * contributor license agreements.  See the NOTICE file distributed with
004     * this work for additional information regarding copyright ownership.
005     * The ASF licenses this file to You under the Apache License, Version 2.0
006     * (the "License"); you may not use this file except in compliance with
007     * the License.  You may obtain a copy of the License at
008     *
009     *      http://www.apache.org/licenses/LICENSE-2.0
010     *
011     * Unless required by applicable law or agreed to in writing, software
012     * distributed under the License is distributed on an "AS IS" BASIS,
013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     * See the License for the specific language governing permissions and
015     * limitations under the License.
016     */
017    package org.apache.camel;
018    
019    public interface NamedNode {
020    
021        /**
022         * Gets the value of the id property.
023         */
024        String getId();
025    
026        /**
027         * Returns a short name for this node which can be useful for ID generation or referring to related resources like images
028         *
029         * @return defaults to "node" but derived nodes should overload this to provide a unique name
030         */
031        String getShortName();
032    
033        /**
034         * Returns the description text or null if there is no description text associated with this node
035         */
036        String getDescriptionText();
037    
038    }