Mercurial > hg > release > thermostat-1.6
view experimental/collections/src/main/java/com/redhat/thermostat/experimental/collections/graph/Graph.java @ 2049:a92d602216ad
Update copyright license headers for 2017
PR3290
Reviewed-by: jerboaa
Review-thread: http://icedtea.classpath.org/pipermail/thermostat/2017-January/021974.html
author | Andrew Azores <aazores@redhat.com> |
---|---|
date | Tue, 17 Jan 2017 12:19:56 -0500 |
parents | b4f7278c8acd |
children |
line wrap: on
line source
/* * Copyright 2012-2017 Red Hat, Inc. * * This file is part of Thermostat. * * Thermostat is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published * by the Free Software Foundation; either version 2, or (at your * option) any later version. * * Thermostat is distributed in the hope that it will be useful, but * WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * General Public License for more details. * * You should have received a copy of the GNU General Public License * along with Thermostat; see the file COPYING. If not see * <http://www.gnu.org/licenses/>. * * Linking this code with other modules is making a combined work * based on this code. Thus, the terms and conditions of the GNU * General Public License cover the whole combination. * * As a special exception, the copyright holders of this code give * you permission to link this code with independent modules to * produce an executable, regardless of the license terms of these * independent modules, and to copy and distribute the resulting * executable under terms of your choice, provided that you also * meet, for each linked independent module, the terms and conditions * of the license of that module. An independent module is a module * which is not derived from or based on this code. If you modify * this code, you may extend this exception to your version of the * library, but you are not obligated to do so. If you do not wish * to do so, delete this exception statement from your version. */ package com.redhat.thermostat.experimental.collections.graph; import java.util.Iterator; import java.util.Set; /** * A simple interface defining methods for a general purpose Graph where * the {@code Vertices} in the Graph are represented by {@link Node}s and the * {@code Edges} are the {@link Relationship}s between them. */ public interface Graph extends Iterable<Node> { /** * Creates a new {@link Relationship} to this Graph * from the given {@code node}s and {@code relationship} {@code String} * representation. * Returns the {@link Relationship} just created or {@code null} if the * {@link Relationship} was not added to the Graph. */ Relationship addRelationship(Node source, String relationship, Node destination); /** * Adds the given {@link Relationship} to this Graph. * Returns {@code true} if the operation was successful, {@code false} * otherwise. */ boolean addRelationship(Relationship relationship); /** * Returns the size of this Graph. The size of a Graph is the number of * {@link Relationship}s contained in the Graph, not the number of * {@link Node}s. A Graph with size of zero may still * contain a number of not-connected Nodes. Such Graph is considered empty * and is referred to as Null-Graph or Edgeless. */ int size(); /** * Returns the order, or the number of {@link Node}s, of this Graph. * A Zero-Order Graph is an empty graph with no Nodes and no Relationships. */ int order(); /** * Returns a {@link Set<Relationship>} containing all the relationship * in this Graph. */ Set<Relationship> getRelationships(Node node); /** * Returns an iterator over this graph nodes. The order of the iterator * is not defined and is implementation dependent. */ @Override Iterator<Node> iterator(); /** * Clear the graph by removing all its content. The running time of this * method is implementation dependent. */ void clear(); }