Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.poi.hwpf.model
Class PropertyNode<T extends PropertyNode<T>>

    java.lang.Object
      org.apache.poi.hwpf.model.PropertyNode<T>

All Implemented Interfaces:
  java.lang.Cloneable, java.lang.Comparable<T>

Direct Known Subclasses:
  BytePropertyNode, GenericPropertyNode, SEPX, TextPiece

    @Internal
    public abstract class PropertyNode<T extends PropertyNode<T>>

extends java.lang.Object
implements java.lang.Comparable<T>, java.lang.Cloneable

Represents a lightweight node in the Trees used to store content properties. This only ever works in characters. For the few odd cases when the start and end aren't in characters (eg PAPX and CHPX), use `BytePropertyNode` between you and this.

Author:
  Ryan Ackley

Nested Class Summary
`static class` | `PropertyNode.EndComparator`
`static class` | `PropertyNode.StartComparator`

Field Summary
`protected java.lang.Object` | `_buf`

Constructor Summary
`protected` | `PropertyNode(int fcStart, int fcEnd, java.lang.Object buf)`

Method Summary
`void` | `adjustForDelete(int start, int length)` Adjust for a deletion that can span multiple PropertyNodes.
`T` | `clone()`
`int` | `compareTo(T o)` Used for sorting in collections.
`boolean` | `equals(java.lang.Object o)`
`int` | `getEnd()`
`int` | `getStart()`
`int` | `hashCode()`
`protected boolean` | `limitsAreEqual(java.lang.Object o)`
`void` | `setEnd(int end)`
`void` | `setStart(int start)`

Methods inherited from class java.lang.Object
`finalize, getClass, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### _buf

    protected java.lang.Object _buf

Constructor Detail

### PropertyNode

    protected PropertyNode(int fcStart,
                           int fcEnd,
                           java.lang.Object buf)

Parameters:
  `fcStart` - The start of the text for this property, in characters.
  `fcEnd` - The end of the text for this property, in characters.
  `buf` - FIXME: Old documentation is: "grpprl The property description in compressed form."

Method Detail

### getStart

    public int getStart()

  Returns:
    The start offset of this property's text.

### setStart

    public void setStart(int start)

### getEnd

    public int getEnd()

  Returns:
    The offset of the end of this property's text.

### setEnd

    public void setEnd(int end)

### adjustForDelete

    public void adjustForDelete(int start,
                                int length)

  Adjust for a deletion that can span multiple PropertyNodes.

  Parameters:
    `start` -
    `length` -

### limitsAreEqual

    protected boolean limitsAreEqual(java.lang.Object o)

### hashCode

    public int hashCode()

  Overrides:
    `hashCode` in class `java.lang.Object`

### equals

    public boolean equals(java.lang.Object o)

  Overrides:
    `equals` in class `java.lang.Object`

### clone

    public T clone()
                                    throws java.lang.CloneNotSupportedException

  Overrides:
    `clone` in class `java.lang.Object`
  Throws:
    `java.lang.CloneNotSupportedException`

### compareTo

    public int compareTo(T o)

  Used for sorting in collections.

  Specified by:
    `compareTo` in interface `java.lang.Comparable<T extends PropertyNode<T>>`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright 2017 The Apache Software Foundation or its licensors, as applicable.