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   * Represents an anchor
26   *
27   * @author Juan F. Codagnone
28   * @version $Id: AnchorBlock.java 763762 2009-04-09 18:19:56Z ltheussl $
29   */
30  class AnchorBlock
31      implements Block
32  {
33      /**
34       * anchor name
35       */
36      private final String name;
37  
38      /**
39       * Creates the AnchorBlock.
40       *
41       * @param name name of the anchor, not null.
42       */
43      AnchorBlock( final String name )
44      {
45          if ( name == null )
46          {
47              throw new IllegalArgumentException( "argument can't be null" );
48          }
49          this.name = name;
50      }
51  
52      /** {@inheritDoc}*/
53      public final void traverse( final Sink sink )
54      {
55          sink.anchor( name );
56          sink.anchor_();
57      }
58  
59      /** {@inheritDoc}*/
60      public final boolean equals( final Object obj )
61      {
62          boolean ret = false;
63  
64          if ( obj == this )
65          {
66              ret = true;
67          }
68          else if ( obj instanceof AnchorBlock )
69          {
70              final AnchorBlock a = (AnchorBlock) obj;
71  
72              ret = name.equals( a.name );
73          }
74  
75          return ret;
76      }
77  
78      /** {@inheritDoc}*/
79      public final int hashCode()
80      {
81          return name.hashCode();
82      }
83  
84      /** {@inheritDoc}*/
85      public String toString()
86      {
87          return name;
88      }
89  }