/*
 * 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.olingo.client.api.uri;


/**
 * URI Segment types.
 */
public enum SegmentType {

  ENTITY("$entity"),
  ENTITYSET,
  SINGLETON,
  KEY,
  KEY_AS_SEGMENT,
  PROPERTY,
  NAVIGATION,
  DERIVED_ENTITY_TYPE,
  VALUE("$value"),
  COUNT("$count"),
  BOUND_OPERATION,
  UNBOUND_OPERATION,
  BOUND_ACTION,
  UNBOUND_ACTION,
  METADATA("$metadata"),
  BATCH("$batch"),
  LINKS("$links"),
  REF("$ref"),
  CROSS_JOIN("$crossjoin"),
  ALL("$all"),
  /**
   * For query options like $count that need to stay in their own segment, right after service root.
   * @see QueryOption#COUNT
   */
  ROOT_QUERY_OPTION,
  SERVICEROOT;

  private final String value;

  private SegmentType() {
    this.value = "";
  }

  private SegmentType(final String value) {
    this.value = value;
  }

  public String getValue() {
    return value;
  }
}
