src/Lucene.Net.Analysis.Common/Analysis/Compound/hyphenation/Hyphen.cs

using System.Text;

namespace Lucene.Net.Analysis.Compound.Hyphenation
{
    /*
     * 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.
     */

    /// <summary>
    /// 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.
    /// 
    /// This class has been taken from the Apache FOP project (http://xmlgraphics.apache.org/fop/). They have been slightly modified. 
    /// </summary>
    public class Hyphen
    {
        public string preBreak;

        public string noBreak;

        public string postBreak;

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

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

        public override 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();
        }
    }
}