Lucene.Net  3.0.3
Lucene.Net is a port of the Lucene search engine library, written in C# and targeted at .NET runtime users.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Pages
PayloadAttribute.cs
Go to the documentation of this file.
1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements. See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
18 using System;
19 using Attribute = Lucene.Net.Util.Attribute;
20 using Payload = Lucene.Net.Index.Payload;
21 
22 namespace Lucene.Net.Analysis.Tokenattributes
23 {
24 
25  /// <summary> The payload of a Token. See also <see cref="Payload" />.</summary>
26  [Serializable]
27  public class PayloadAttribute:Attribute, IPayloadAttribute, System.ICloneable
28  {
29  private Payload payload;
30 
31  /// <summary> Initialize this attribute with no payload.</summary>
33  {
34  }
35 
36  /// <summary> Initialize this attribute with the given payload. </summary>
37  public PayloadAttribute(Payload payload)
38  {
39  this.payload = payload;
40  }
41 
42  /// <summary> Returns this Token's payload.</summary>
43  public virtual Payload Payload
44  {
45  get { return this.payload; }
46  set { this.payload = value; }
47  }
48 
49  public override void Clear()
50  {
51  payload = null;
52  }
53 
54  public override System.Object Clone()
55  {
56  var clone = (PayloadAttribute) base.Clone();
57  if (payload != null)
58  {
59  clone.payload = (Payload) payload.Clone();
60  }
61  return clone;
62  // TODO: This code use to be as below. Any reason why? the if(payload!=null) was missing...
63  //PayloadAttributeImpl impl = new PayloadAttributeImpl();
64  //impl.payload = new Payload(this.payload.data, this.payload.offset, this.payload.length);
65  //return impl;
66  }
67 
68  public override bool Equals(System.Object other)
69  {
70  if (other == this)
71  {
72  return true;
73  }
74 
75  if (other is IPayloadAttribute)
76  {
78  if (o.payload == null || payload == null)
79  {
80  return o.payload == null && payload == null;
81  }
82 
83  return o.payload.Equals(payload);
84  }
85 
86  return false;
87  }
88 
89  public override int GetHashCode()
90  {
91  return (payload == null)?0:payload.GetHashCode();
92  }
93 
94  public override void CopyTo(Attribute target)
95  {
97  t.Payload = (payload == null)?null:(Payload) payload.Clone();
98  }
99  }
100 }