io.bloombox.schema.search.ResultHighlightMode Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-client Show documentation
Java RPCAPI client for the Bloombox Cloud.
The newest version!
/*
 * Copyright 2019, Momentum Ideas, Co. All rights reserved.
 *
 * Source and object computer code contained herein is the private intellectual
 * property of Momentum Ideas Co., a Delaware Corporation. Use of this
 * code in source form requires permission in writing before use or the
 * assembly, distribution, or publishing of derivative works, for commercial
 * purposes or any other purpose, from a duly authorized officer of Momentum
 * Ideas Co.
 *
 * 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.
 */

// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: search/SearchSpec.proto

package io.bloombox.schema.search;

/**
 *  * Specifies available modes to highlight terms in search results.
 * 
 *
 * Protobuf enum {@code bloombox.search.ResultHighlightMode}
 */
public enum ResultHighlightMode
    implements com.google.protobuf.ProtocolMessageEnum {
  /**
   *    * No highlighting is requested.
   * 
   *
   * NO_HIGHLIGHTING = 0;
   */
  NO_HIGHLIGHTING(0),
  /**
   *    * HTML highlighting is requested.
   * 
   *
   * HTML = 1;
   */
  HTML(1),
  /**
   *    * Markdown highlighting is requested.
   * 
   *
   * MARKDOWN = 2;
   */
  MARKDOWN(2),
  /**
   *    * Only return snippets of matching text.
   * 
   *
   * SNIPPET = 3;
   */
  SNIPPET(3),
  UNRECOGNIZED(-1),
  ;

  /**
   *    * No highlighting is requested.
   * 
   *
   * NO_HIGHLIGHTING = 0;
   */
  public static final int NO_HIGHLIGHTING_VALUE = 0;
  /**
   *    * HTML highlighting is requested.
   * 
   *
   * HTML = 1;
   */
  public static final int HTML_VALUE = 1;
  /**
   *    * Markdown highlighting is requested.
   * 
   *
   * MARKDOWN = 2;
   */
  public static final int MARKDOWN_VALUE = 2;
  /**
   *    * Only return snippets of matching text.
   * 
   *
   * SNIPPET = 3;
   */
  public static final int SNIPPET_VALUE = 3;


  public final int getNumber() {
    if (this == UNRECOGNIZED) {
      throw new java.lang.IllegalArgumentException(
          "Can't get the number of an unknown enum value.");
    }
    return value;
  }

  /**
   * @deprecated Use {@link #forNumber(int)} instead.
   */
  @java.lang.Deprecated
  public static ResultHighlightMode valueOf(int value) {
    return forNumber(value);
  }

  public static ResultHighlightMode forNumber(int value) {
    switch (value) {
      case 0: return NO_HIGHLIGHTING;
      case 1: return HTML;
      case 2: return MARKDOWN;
      case 3: return SNIPPET;
      default: return null;
    }
  }

  public static com.google.protobuf.Internal.EnumLiteMap
      internalGetValueMap() {
    return internalValueMap;
  }
  private static final com.google.protobuf.Internal.EnumLiteMap<
      ResultHighlightMode> internalValueMap =
        new com.google.protobuf.Internal.EnumLiteMap() {
          public ResultHighlightMode findValueByNumber(int number) {
            return ResultHighlightMode.forNumber(number);
          }
        };

  public final com.google.protobuf.Descriptors.EnumValueDescriptor
      getValueDescriptor() {
    return getDescriptor().getValues().get(ordinal());
  }
  public final com.google.protobuf.Descriptors.EnumDescriptor
      getDescriptorForType() {
    return getDescriptor();
  }
  public static final com.google.protobuf.Descriptors.EnumDescriptor
      getDescriptor() {
    return io.bloombox.schema.search.SearchMetadata.getDescriptor().getEnumTypes().get(2);
  }

  private static final ResultHighlightMode[] VALUES = values();

  public static ResultHighlightMode valueOf(
      com.google.protobuf.Descriptors.EnumValueDescriptor desc) {
    if (desc.getType() != getDescriptor()) {
      throw new java.lang.IllegalArgumentException(
        "EnumValueDescriptor is not for this type.");
    }
    if (desc.getIndex() == -1) {
      return UNRECOGNIZED;
    }
    return VALUES[desc.getIndex()];
  }

  private final int value;

  private ResultHighlightMode(int value) {
    this.value = value;
  }

  // @@protoc_insertion_point(enum_scope:bloombox.search.ResultHighlightMode)
}