org.apache.tinkerpop.gremlin.ogm.annotations.Element.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kotlin-gremlin-ogm Show documentation

The Object Graph Mapping Library for Kotlin and Gremlin

There is a newer version: 0.21.0

package org.apache.tinkerpop.gremlin.ogm.annotations

import java.lang.annotation.Inherited


/**
 * Marks a class as capable of being mapped to an element of the graph (edge or vertex).
 * Clients should register classes marked with @Element with a GraphMapper.
 */
@Retention(value = AnnotationRetention.RUNTIME)
@Target(allowedTargets = [(AnnotationTarget.CLASS)])
@Inherited
annotation class Element(

        /**
         * The label of the vertex or edge when stored to the graph. We require clients to specify an explicit
         * label (instead of using the class name) to guard against refactoring situations
         * where the class name is changed and this annotation is not updated to keep the original label.
         */
        val label: String)