com.tinkerpop.frames.Adjacency Maven / Gradle / Ivy

Go to download

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

Frames is a framework for exposing the elements of a Blueprints graph as Java objects. Instead of writing software in terms of vertices and edges, with Frames, software is written in terms of domain objects and their relationships to each other.

There is a newer version: 2.6.0

Show newest version

package com.tinkerpop.frames;

import com.tinkerpop.blueprints.Direction;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Adjacencies annotate getters and adders to represent a Vertex adjacent to a Vertex.
 *
 * @author Marko A. Rodriguez (http://markorodriguez.com)
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Adjacency {
    /**
     * The label of the edges making the adjacency between the vertices.
     *
     * @return the edge label
     */
    public String label();

    /**
     * The edge direction of the adjacency.
     *
     * @return the direction of the edges composing the adjacency
     */
    public Direction direction() default Direction.OUT;
}