org.intrigus.smartgraph.graph.Edge Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of smartgraph Show documentation

Generic (Java FX) Graph Visualization Library

The newest version!

/* 
 * The MIT License
 *
 * Copyright 2019 [email protected].
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.intrigus.smartgraph.graph;

/**
 * An edge connects two {@link Vertex} of type V and stores
 * an element of type E.
 * 
 * The edge may be used in oriented and non-oriented graphs.
 * 
 * @param  Type of value stored in the edge
 * @param  Type of value stored in the vertices that this edge connects.
 * 
 * @see Graph
 * @see Digraph
 */
public interface Edge {
    
    /**
     * Returns the element stored in the edge.
     * 
     * @return      stored element
     */
    public E element();
    
    /**
     * Returns and array of size 2, with references for both vertices at the ends
     * of an edge.
     * 
     * In a {@link Digraph} the reference at {@code vertices()[0]} must be that
     * of the outbound vertex and at {@code vertices()[1]} that of the inbound
     * vertex.
     * 
     * @return      an array of length 2, containing the vertices at both ends.
     */
    public Vertex[] vertices();
    
    
}