/*
 * #%L
 * wcm.io
 * %%
 * Copyright (C) 2018 wcm.io
 * %%
 * 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.
 * #L%
 */
package io.wcm.qa.glnm.sampling.transform.regex;

import java.util.regex.Matcher;
import java.util.regex.Pattern;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import io.wcm.qa.glnm.sampling.Sampler;
import io.wcm.qa.glnm.sampling.transform.base.RegexBasedSampler;

/**
 * Samples first match of regular expression from input string.
 *
 * @param <S>
 * @since 1.0.0
 */
public class RegexSampler<S extends Sampler<String>> extends RegexBasedSampler<S, String> {

  private static final Logger LOG = LoggerFactory.getLogger(RegexSampler.class);

  /**
   * <p>Constructor for RegexSampler.</p>
   *
   * @param inputSampler providing the input string
   * @param pattern used to transform
   * @since 3.0.0
   */
  public RegexSampler(S inputSampler, Pattern pattern) {
    super(inputSampler, pattern);
  }

  /**
   * <p>Constructor for RegexSampler.</p>
   *
   * @param inputSampler providing the input string
   * @param regex to build transformation {@link java.util.regex.Pattern} from
   * @since 3.0.0
   */
  public RegexSampler(S inputSampler, String regex) {
    super(inputSampler, regex);
  }

  /**
   * <p>Constructor for RegexSampler.</p>
   *
   * @param inputSampler providing the input string
   * @param regex to build transformation {@link java.util.regex.Pattern} from
   * @param flags to regular expression
   * @since 3.0.0
   */
  public RegexSampler(S inputSampler, String regex, int flags) {
    super(inputSampler, regex, flags);
  }


  @Override
  protected String extractValue(Matcher matcher) {
    if (matcher.find()) {
      LOG.trace(getClass().getSimpleName() + ": found match for '" + getPattern() + "'");
      return matcher.group();
    }
    LOG.trace(getClass().getSimpleName() + ": no match found for '" + getPattern() + "'");
    return handleNoMatch();
  }

}

@@ -984,16 +984,38 @@
 aram %3CS%3E
+ type of input sampler
 %0A * @sin

add description to javadoc