diff options
Diffstat (limited to 'framework/src/onos/core/api/src/main/java/org/onosproject/net/topology/GraphDescription.java')
-rw-r--r-- | framework/src/onos/core/api/src/main/java/org/onosproject/net/topology/GraphDescription.java | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/framework/src/onos/core/api/src/main/java/org/onosproject/net/topology/GraphDescription.java b/framework/src/onos/core/api/src/main/java/org/onosproject/net/topology/GraphDescription.java new file mode 100644 index 00000000..806a5a45 --- /dev/null +++ b/framework/src/onos/core/api/src/main/java/org/onosproject/net/topology/GraphDescription.java @@ -0,0 +1,57 @@ +/* + * Copyright 2014-2015 Open Networking Laboratory + * + * 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 org.onosproject.net.topology; + +import org.onosproject.net.Description; + +import com.google.common.collect.ImmutableSet; + +/** + * Describes attribute(s) of a network graph. + */ +public interface GraphDescription extends Description { + + /** + * Returns the creation timestamp of the graph description. This is + * expressed in system nanos to allow proper sequencing. + * + * @return graph description creation timestamp + */ + long timestamp(); + + /** + * Returns the creation timestamp of the graph description. This is + * expressed in system millis to allow proper date and time formatting. + * + * @return graph description creation timestamp in millis + */ + long creationTime(); + + /** + * Returns the set of topology graph vertexes. + * + * @return set of graph vertexes + */ + ImmutableSet<TopologyVertex> vertexes(); + + /** + * Returns the set of topology graph edges. + * + * @return set of graph edges + */ + ImmutableSet<TopologyEdge> edges(); + +} |