lucene/analysis/common/src/java/org/apache/lucene/analysis/compound/hyphenation/Hyphen.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.compound.hyphenation;

/**
 * This class represents a hyphen. A 'full' hyphen is made of 3 parts: the pre-break text,
 * post-break text and no-break. If no line-break is generated at this position, the no-break text
 * is used, otherwise, pre-break and post-break are used. Typically, pre-break is equal to the
 * hyphen character and the others are empty. However, this general scheme allows support for cases
 * in some languages where words change spelling if they're split across lines, like german's
 * 'backen' which hyphenates 'bak-ken'. BTW, this comes from TeX.
 *
 * <p>This class has been taken from the Apache FOP project (http://xmlgraphics.apache.org/fop/).
 * They have been slightly modified.
 */
public class Hyphen {
  public String preBreak;

  public String noBreak;

  public String postBreak;

  Hyphen(String pre, String no, String post) {
    preBreak = pre;
    noBreak = no;
    postBreak = post;
  }

  Hyphen(String pre) {
    preBreak = pre;
    noBreak = null;
    postBreak = null;
  }

  @Override
  public String toString() {
    if (noBreak == null && postBreak == null && preBreak != null && preBreak.equals("-")) {
      return "-";
    }
    StringBuilder res = new StringBuilder("{");
    res.append(preBreak);
    res.append("}{");
    res.append(postBreak);
    res.append("}{");
    res.append(noBreak);
    res.append('}');
    return res.toString();
  }
}