Package ghidra.util.database

Class KeySpan.Domain

java.lang.Object

ghidra.util.database.KeySpan.Domain

All Implemented Interfaces:

Span.Domain<Long,KeySpan>

Enclosing interface:

KeySpan

public static class KeySpan.Domain
extends Object
implements Span.Domain<Long,KeySpan>

The domain of keys

Constructor Summary

Constructors

Constructor	Description
Domain()

Method Summary

Modifier and Type	Method	Description
KeySpan	all()	Get the span containing all values in the domain
int	compare(Long n1, Long n2)	Compare two values
Long	dec(Long n)	Get a given value, decremented by 1
KeySpan	empty()	Get the span that contains no value, nor has any endpoints
Long	inc(Long n)	Get a given value, incremented by 1
Long	max()	Get the maximum value in the domain
Long	min()	Get the minimum value in the domain
KeySpan	newSpan(Long min, Long max)	Factory method for a new span after arguments are validated

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface generic.Span.Domain

atLeast, atMost, bound, closed, encloses, intersect, intersects, max, min, subtract, toMaxString, toMinString, toString, toString, toString, value

Constructor Details

Domain

public Domain()

Method Details

newSpan

public KeySpan newSpan(Long min,
 Long max)

Description copied from interface: Span.Domain

Factory method for a new span after arguments are validated

Specified by:

newSpan in interface Span.Domain<Long,KeySpan>

Parameters:

min - the lower endpoint

max - the upper endpoint

Returns:

the span

empty

public KeySpan empty()

Description copied from interface: Span.Domain

Get the span that contains no value, nor has any endpoints

This span is returned when the result doesn't exist, e.g., when finding the intersection of spans which do not intersect.

Specified by:

empty in interface Span.Domain<Long,KeySpan>

Returns:

the empty span

all

public KeySpan all()

Description copied from interface: Span.Domain

Get the span containing all values in the domain

Specified by:

all in interface Span.Domain<Long,KeySpan>

Returns:

the span

compare

public int compare(Long n1,
 Long n2)

Description copied from interface: Span.Domain

Compare two values

Specified by:

compare in interface Span.Domain<Long,KeySpan>

Parameters:

n1 - a value

n2 - another value

Returns:

the result, as in Comparator.compare(Object, Object)

min

public Long min()

Description copied from interface: Span.Domain

Get the minimum value in the domain

This value can also represent negative infinity.

Specified by:

min in interface Span.Domain<Long,KeySpan>

Returns:

the minimum value

max

public Long max()

Description copied from interface: Span.Domain

Get the maximum value in the domain

This value can also represent positive infinity.

Specified by:

max in interface Span.Domain<Long,KeySpan>

Returns:

the maximum value

inc

public Long inc(Long n)

Description copied from interface: Span.Domain

Get a given value, incremented by 1

If the resulting value would exceed Span.Domain.max(), this should wrap to Span.Domain.min().

Specified by:

inc in interface Span.Domain<Long,KeySpan>

Parameters:

n - the value

Returns:

the value incremented

dec

public Long dec(Long n)

Description copied from interface: Span.Domain

Get a given value, decremented by 1

If the resulting value would exceed Span.Domain.min(), this should wrap to Span.Domain.max().

Specified by:

dec in interface Span.Domain<Long,KeySpan>

Parameters:

n - the value

Returns:

the value decremented