lucene/analysis/common/src/java/org/apache/lucene/analysis/core/WhitespaceAnalyzer.java

/*
 * 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.lucene.analysis.core;


import org.apache.lucene.analysis.Analyzer;

/**
 * An Analyzer that uses {@link WhitespaceTokenizer}.
 *
 * @since 3.1
 **/
public final class WhitespaceAnalyzer extends Analyzer {

  private final int maxTokenLength;
  
  /**
   * Creates a new {@link WhitespaceAnalyzer} with a maximum token length of 255 chars
   */
  public WhitespaceAnalyzer() {
    this(WhitespaceTokenizer.DEFAULT_MAX_WORD_LEN);
  }

  /**
   * Creates a new {@link WhitespaceAnalyzer} with a custom maximum token length
   * @param maxTokenLength the maximum token length the analyzer will emit
   */
  public WhitespaceAnalyzer(int maxTokenLength) {
    this.maxTokenLength = maxTokenLength;
  }
  
  @Override
  protected TokenStreamComponents createComponents(final String fieldName) {
    return new TokenStreamComponents(new WhitespaceTokenizer(maxTokenLength));
  }
}