001    package org.apache.commons.graph;
002    
003    /*
004     * Licensed to the Apache Software Foundation (ASF) under one
005     * or more contributor license agreements.  See the NOTICE file
006     * distributed with this work for additional information
007     * regarding copyright ownership.  The ASF licenses this file
008     * to you under the Apache License, Version 2.0 (the
009     * "License"); you may not use this file except in compliance
010     * with the License.  You may obtain a copy of the License at
011     *
012     *   http://www.apache.org/licenses/LICENSE-2.0
013     *
014     * Unless required by applicable law or agreed to in writing,
015     * software distributed under the License is distributed on an
016     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017     * KIND, either express or implied.  See the License for the
018     * specific language governing permissions and limitations
019     * under the License.
020     */
021    
022    /**
023     * A WeightedEdge is an {@link Edge} where a number (weight) is assigned to represent, for example,
024     * costs, lengths or capacities, etc. depending on the problem.
025     *
026     * @param <V> the Graph vertices type
027     */
028    public interface WeightedEdge<V extends Vertex>
029        extends Edge<V>, Comparable<WeightedEdge<V>>
030    {
031    
032        /**
033         * Gets the weight attribute of the WeightedEdge object
034         *
035         * @return the weight attribute of the WeightedEdge object
036         */
037        Double getWeight();
038    
039    }