KIMAP::ImapSet

#include <imapset.h>

Public Types

typedef qint64 Id
 

Public Member Functions

 ImapSet ()
 
 ImapSet (Id begin, Id end)
 
 ImapSet (Id value)
 
 ImapSet (const ImapSet &other)
 
 ~ImapSet ()
 
void add (Id value)
 
void add (const QVector< Id > &values)
 
void add (const ImapInterval &interval)
 
ImapInterval::List intervals () const
 
bool isEmpty () const
 
ImapSetoperator= (const ImapSet &other)
 
bool operator== (const ImapSet &other) const
 
void optimize ()
 
QByteArray toImapSequenceSet () const
 

Static Public Member Functions

static ImapSet fromImapSequenceSet (const QByteArray &sequence)
 

Detailed Description

Represents a set of natural numbers (1->∞) in a as compact as possible form.

Used to address Akonadi items via the IMAP protocol or in the database. This class is implicitly shared.

Definition at line 128 of file imapset.h.

Member Typedef Documentation

typedef qint64 KIMAP::ImapSet::Id

Describes the ids stored in the set.

Definition at line 134 of file imapset.h.

Constructor & Destructor Documentation

ImapSet::ImapSet ( )

Constructs an empty set.

Definition at line 176 of file imapset.cpp.

ImapSet::ImapSet ( Id  begin,
Id  end 
)

Constructs a set containing a single interval.

Definition at line 181 of file imapset.cpp.

ImapSet::ImapSet ( Id  value)
explicit

Constructs a set containing a single value.

Definition at line 187 of file imapset.cpp.

ImapSet::ImapSet ( const ImapSet other)

Copy constructor.

Definition at line 193 of file imapset.cpp.

ImapSet::~ImapSet ( )

Destructor.

Definition at line 198 of file imapset.cpp.

Member Function Documentation

void ImapSet::add ( Id  value)

Adds a single positive integer numbers to the set.

The list is sorted and split into as large as possible intervals. No interval merging is performed.

Parameters
valueA positive integer number

Definition at line 225 of file imapset.cpp.

void ImapSet::add ( const QVector< Id > &  values)

Adds the given list of positive integer numbers to the set.

The list is sorted and split into as large as possible intervals. No interval merging is performed.

Parameters
valuesList of positive integer numbers in arbitrary order

Definition at line 230 of file imapset.cpp.

void ImapSet::add ( const ImapInterval interval)

Adds the given ImapInterval to this set.

No interval merging is performed.

Parameters
intervalthe interval to add

Definition at line 253 of file imapset.cpp.

ImapSet ImapSet::fromImapSequenceSet ( const QByteArray sequence)
static

Return the set corresponding to the given IMAP-compatible QByteArray representation.

Definition at line 281 of file imapset.cpp.

ImapInterval::List ImapSet::intervals ( ) const

Returns the intervals this set consists of.

Definition at line 296 of file imapset.cpp.

bool ImapSet::isEmpty ( ) const

Returns true if this set doesn't contains any values.

Definition at line 301 of file imapset.cpp.

ImapSet & ImapSet::operator= ( const ImapSet other)

Assignment operator.

Definition at line 202 of file imapset.cpp.

bool ImapSet::operator== ( const ImapSet other) const

Comparison operator.

Definition at line 210 of file imapset.cpp.

void ImapSet::optimize ( )

Optimizes the ImapSet by sorting and merging overlapping intervals.

Normally you shouldn't need to call this method. KIMAP will make sure to opimize the ImapSet before serializing it to string and sending it to the IMAP server.

Definition at line 306 of file imapset.cpp.

QByteArray ImapSet::toImapSequenceSet ( ) const

Returns a IMAP-compatible QByteArray representation of this set.

Definition at line 258 of file imapset.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Nov 30 2020 23:12:58 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.