api/src/main/java/org/apache/commons/graph/Weighted.java

package org.apache.commons.graph;

/*
 * 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.
 */

/**
 * A Weighted object has a property called weight, which usually denotes
 * its relative importance within the domain of interest.
 *
 * @param <W> the type of weight
 */
public interface Weighted<W>
{

    /**
     * Gets the weight of the {@code Weighted} object.
     *
     * @return the weight of the {@code Weighted} object.
     */
    W getWeight();

}