org.gwtproject.regexp.shared.MatchResult Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gwt-regexp Show documentation

GWT Regular Expression

The newest version!

/*
 * Copyright © 2019 The GWT Project Authors
 *
 * Licensed 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.gwtproject.regexp.shared;

public interface MatchResult {

  /**
   * Retrieves the matched string or the given matched group.
   *
   * @param index the index of the group to return, 0 to return the whole matched string; must be
   *     between 0 and {@code getGroupCount() - 1} included
   * @return The matched string if {@code index} is zero, else the given matched group. If the given
   *     group was optional and did not match, the behavior is browser-dependent: this method will
   *     return {@code null} or an empty string.
   */
  String getGroup(int index);

  /**
   * Returns the number of groups, including the matched string hence greater or equal than 1.
   *
   * @return the group count
   */
  int getGroupCount();

  /**
   * Returns the zero-based index of the match in the input string.
   *
   * @return the index
   */
  int getIndex();

  /**
   * Returns the original input string.
   *
   * @return the input
   */
  String getInput();
}