com.sap.cds.ql.cqn.Path Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cds4j-api Show documentation

CDS4J API

There is a newer version: 3.6.1

/*******************************************************************
 * © 2020 SAP SE or an SAP affiliate company. All rights reserved. *
 *******************************************************************/
package com.sap.cds.ql.cqn;

import java.util.Iterator;

public interface Path extends Iterable {

	/**
	 * Returns an iterator over {@link ResolvedSegment ResolvedSegment(s)}.
	 *
	 * @return an Iterator
	 */
	@Override
	Iterator iterator();

	/**
	 * Returns a reverse order iterator over {@link ResolvedSegment
	 * ResolvedSegment(s)}, starting from the target segment.
	 *
	 * @return an Iterator
	 */
	Iterator reverse();

	/**
	 * Returns the root segment of the path.
	 *
	 * @return the root segment
	 */
	ResolvedSegment root();

	/**
	 * Returns the target segment of the path.
	 *
	 * @return the target segment
	 */
	ResolvedSegment target();

	/**
	 * Converts this path to a {@link CqnReference}.
	 *
	 * @return this path as ref
	 */
	CqnReference toRef();

}