/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you 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.apache.tinkerpop.gremlin.object.traversal.library;

import org.apache.tinkerpop.gremlin.object.traversal.SubTraversal;
import org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversal;
import org.apache.tinkerpop.gremlin.structure.Element;
import org.apache.tinkerpop.gremlin.structure.Vertex;

import lombok.Data;
import lombok.RequiredArgsConstructor;
import lombok.experimental.Accessors;

/**
 * {@link Out} selects outgoing adjacent vertices that can be reached through the given edge label.
 *
 * @author Karthick Sankarachary (http://github.com/karthicks)
 */
@Data
@Accessors(fluent = true, chain = true)
@RequiredArgsConstructor(staticName = "of")
@SuppressWarnings({"PMD.ShortClassName"})
public class Out implements SubTraversal<Element, Vertex> {

  private final String label;

  @SuppressWarnings("PMD.ShortMethodName")
  public static Out of(org.apache.tinkerpop.gremlin.object.structure.Element element) {
    return of(org.apache.tinkerpop.gremlin.object.reflect.Label.of(element));
  }

  @SuppressWarnings("PMD.ShortMethodName")
  public static Out of(
      Class<? extends org.apache.tinkerpop.gremlin.object.structure.Element> elementType) {
    return of(org.apache.tinkerpop.gremlin.object.reflect.Label.of(elementType));
  }

  @Override
  public GraphTraversal<Element, Vertex> apply(GraphTraversal<Element, Element> traversal) {
    return traversal.out(label);
  }

}