ImmutableFragment (http-base 0.1 API)

java.lang.Object
- xyz.cofe.common.ImmutableFragment

Direct Known Subclasses:

Fragment
```
public class ImmutableFragment
extends Object
```
Фрагмент данных.
Связан с картой String / Object.
Ключи карты используемые с этом классе:
begin : long
end : long

Author:

Kamnev Georgiy (nt.gocha@gmail.com)

Field Summary

Fields
Modifier and Type Field and Description

protected long begin

protected long end

long instanceID

static AtomicLong sequneceID

Fields
Modifier and Type	Field and Description
`protected long`	`begin`
`protected long`	`end`
`long`	`instanceID`
`static AtomicLong`	`sequneceID`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ImmutableFragment()`
	`ImmutableFragment(ImmutableFragment source)` Конструктор копирования
	`ImmutableFragment(long begin, long end)` Конструктор

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ImmutableFragment`	`clone()` Создание клона
`Long`	`distance(ImmutableFragment fragment)` Определяет растояние между фрагментами
`boolean`	`equalsRange(ImmutableFragment fragment)` Проверка совпадения диапазона
`boolean`	`follow(ImmutableFragment fragment)` Проверка что данный объект расположен вплотную после указанного, но не пересекается - то есть следует: .... [ fragment ] [ this ] ....
`boolean`	`follower(ImmutableFragment fragment)` Проверка что данный объект расположен вплотную перед указанного, но не пересекается: .... [ this ] [ fragment ] ....
`long`	`getBegin()` Начало фрагмента
`long`	`getEnd()` Конец фрагмента от нуля (исключительно)
`long`	`getSize()` Размер фрагмента
`boolean`	`hasIntersection(ImmutableFragment fragment)` Проверка пересечения
`boolean`	`include(ImmutableFragment fragment)` Проверка включения под фрагмента
`protected void`	`init(ImmutableFragment source)`
`protected void`	`init(long begin, long end)`
`ImmutableFragment`	`intersection(ImmutableFragment fragment)` Получение пересечения
`ImmutableFragment`	`range(long begin, long end)` Создает новый фрагмент
`ImmutableFragment`	`size(long newSize)` Указание нового размера
`ImmutableFragment[]`	`substract(ImmutableFragment fragment)` Вычитание фрагмента
`String`	`toString()` Текстовое представление
`ImmutableFragment`	`union(ImmutableFragment fragment)` Объединение фрагментов.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - sequneceID
```
public static final AtomicLong sequneceID
```
  - instanceID
```
public final long instanceID
```
  - begin
```
protected volatile long begin
```
  - end
```
protected volatile long end
```
- Constructor Detail
  - ImmutableFragment
```
public ImmutableFragment(long begin,
                         long end)
```
    Конструктор
    
    Parameters:
    
    begin - Начало фрагмента
    
    end - Конец фрагмент Искл.
  - ImmutableFragment
```
protected ImmutableFragment()
```
  - ImmutableFragment
```
public ImmutableFragment(ImmutableFragment source)
```
    Конструктор копирования
    
    Parameters:
    
    source - образец
- Method Detail
  - init
```
protected void init(long begin,
                    long end)
```
  - init
```
protected void init(ImmutableFragment source)
```
  - clone
```
public ImmutableFragment clone()
```
    Создание клона
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    клон
  - toString
```
public String toString()
```
    Текстовое представление
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    текст
  - getBegin
```
public long getBegin()
```
    Начало фрагмента
    
    Returns:
    
    начало фрагмента
  - getEnd
```
public long getEnd()
```
    Конец фрагмента от нуля (исключительно)
    
    Returns:
    
    Конец фрагмента
  - getSize
```
public long getSize()
```
    Размер фрагмента
    
    Returns:
    
    размер фрагмента
  - range
```
public ImmutableFragment range(long begin,
                               long end)
```
    Создает новый фрагмент
    
    Parameters:
    
    begin - начало, от нуля
    
    end - конец, от нуля исключительно. end должен быть больше или равен begin.
    
    Returns:
    
    фрагмент
  - size
```
public ImmutableFragment size(long newSize)
```
    Указание нового размера
    
    Parameters:
    
    newSize - размер >= 0
    
    Returns:
    
    клон с новыми размерами
  - intersection
```
public ImmutableFragment intersection(ImmutableFragment fragment)
```
    Получение пересечения
    
    Parameters:
    
    fragment - с кем возможно пересечение
    
    Returns:
    
    пересечение или null, если его нет
  - hasIntersection
```
public boolean hasIntersection(ImmutableFragment fragment)
```
    Проверка пересечения
    
    Parameters:
    
    fragment - с кем пересечение
    
    Returns:
    
    true - есть пересечение
  - follow
```
public boolean follow(ImmutableFragment fragment)
```
    Проверка что данный объект расположен вплотную после указанного, но не пересекается - то есть следует: .... [ fragment ] [ this ] ....
    
    Parameters:
    
    fragment - фрагмент после которого следует объект
    
    Returns:
    
    объект следует за указанным
  - follower
```
public boolean follower(ImmutableFragment fragment)
```
    Проверка что данный объект расположен вплотную перед указанного, но не пересекается: .... [ this ] [ fragment ] ....
    
    Parameters:
    
    fragment - фрагмент перед которым следует объект
    
    Returns:
    
    указанный объект следует после объекта
  - union
```
public ImmutableFragment union(ImmutableFragment fragment)
```
    Объединение фрагментов. фрагменты должны иметь пересечение или следовать вполтную друг за другом
    
    Parameters:
    
    fragment - с кем объединение
    
    Returns:
    
    Объединение или null
  - include
```
public boolean include(ImmutableFragment fragment)
```
    Проверка включения под фрагмента
    
    Parameters:
    
    fragment - подфрагмент
    
    Returns:
    
    true - есть включение
  - equalsRange
```
public boolean equalsRange(ImmutableFragment fragment)
```
    Проверка совпадения диапазона
    
    Parameters:
    
    fragment - фрагмент
    
    Returns:
    
    true - совпадение начала и конца диапазона
  - substract
```
public ImmutableFragment[] substract(ImmutableFragment fragment)
```
    Вычитание фрагмента
    
    Parameters:
    
    fragment - вычитаемый фрагмент: substract( fragment ) = this - fragment
    
    Returns:
    
    результат вычитания
  - distance
```
public Long distance(ImmutableFragment fragment)
```
    Определяет растояние между фрагментами
    
    Parameters:
    
    fragment - фрагмент
    
    Returns:
    
    null - если есть пересечения,
    0 - если пересечений нет, но фрагменты следуют друг за другом вплотную
    <0 - если объект следует раньше указанного - указывает на каком растоянии находятся их границы
    >0 - если объект следует позже указанного - указывает на каком растоянии находятся их границы

Class ImmutableFragment

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

sequneceID

instanceID

begin

end

Constructor Detail

ImmutableFragment

ImmutableFragment

ImmutableFragment

Method Detail

init

init

clone

toString

getBegin

getEnd

getSize

range

size

intersection

hasIntersection

follow

follower

union

include

equalsRange

substract

distance