es.usc.citius.hipster.graph.HipsterGraph Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hipster-core Show documentation

The newest version!

/*
 * Copyright 2014 CITIUS , University of Santiago de Compostela.
 *
 *    Licensed 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 es.usc.citius.hipster.graph;

/**
 * Basic definition of the read-only methods for a graph in terms of edges and vertices.
 * @param  vertex type.
 * @param  edge type.
 */
public interface HipsterGraph {
    /**
     * Returns an {@link Iterable} of the edges in the graph.
     * @return an iterable of {@link GraphEdge} in the graph
     */
    Iterable> edges();

    /**
     * Returns an iterable of the vertices in the graph.
     * @return iterable of vertices
     */
    Iterable vertices();

    /**
     * Return all the edges that are connected with the given vertex.
     * @param vertex vertex to be queried
     * @return an iterable of {@link GraphEdge}s connected to the vertex
     */
    Iterable> edgesOf(V vertex);

}