View Javadoc

1   package org.apache.maven.doxia.module.twiki.parser;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import org.apache.maven.doxia.sink.Sink;
23  
24  /**
25   * Block that holds plain text
26   *
27   * @author Juan F. Codagnone
28   * @version $Id: TextBlock.java 763762 2009-04-09 18:19:56Z ltheussl $
29   */
30  class TextBlock
31      implements Block
32  {
33      /**
34       * the text
35       */
36      private final String text;
37  
38      /**
39       * Creates the TextBlock.
40       *
41       * @param text some text. can't ben <code>null</code>
42       * @throws IllegalArgumentException if parameters are not in the domain
43       */
44      TextBlock( final String text )
45      {
46          if ( text == null )
47          {
48              throw new IllegalArgumentException( "argument can't be null" );
49          }
50  
51          this.text = text;
52      }
53  
54      /** {@inheritDoc} */
55      public final void traverse( final Sink sink )
56      {
57          sink.text( text );
58      }
59  
60      /** {@inheritDoc} */
61      public final String toString()
62      {
63          return getClass().getName() + ": [" + text.replaceAll( "\n", "\\n" ) + "]";
64      }
65  
66      /**
67       * Returns the text.
68       *
69       * @return <code>String</code> with the text.
70       */
71      final String getText()
72      {
73          return text;
74      }
75  
76      /** {@inheritDoc} */
77      public final boolean equals( final Object obj )
78      {
79          boolean ret = false;
80  
81          if ( obj == this )
82          {
83              ret = true;
84          }
85          else if ( obj instanceof TextBlock )
86          {
87              final TextBlock textBlock = (TextBlock) obj;
88              ret = text.equals( textBlock.text );
89          }
90  
91          return ret;
92      }
93  
94      /** {@inheritDoc} */
95      public final int hashCode()
96      {
97          return text.hashCode();
98      }
99  }