Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* This file is part of MongoWP.
*
* MongoWP is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* MongoWP is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with bson-core. If not, see .
*
* Copyright (C) 2016 8Kdata.
*
*/
package com.eightkdata.mongowp.bson.utils;
import com.eightkdata.mongowp.bson.BsonDocument;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
/**
*
* @param the class of the source from this reader will read the documents
*/
public interface BsonDocumentReader {
/**
* Reads a document from the input source.
*
* A heap allocation can be specified. The document returned will comply
* that allocation or one more premisive than that if the reader doesn't
* support that heap allocation.
*
* {@link AllocationType#HEAP} must be always supported.
*
* @param allocationType
* @param source
* @return
* @throws BsonDocumentReaderException
*/
@Nonnull
public BsonDocument readDocument(AllocationType allocationType, Source source) throws BsonDocumentReaderException;
public static enum AllocationType {
/**
* Returns documents that are totally stored on the heap.
*/
HEAP(null),
/**
* Returns documents whose metadata is on the heap but heavy values
* reside on the underlaying {@link ByteBuf}.
*/
OFFHEAP_VALUES(HEAP),
/**
* Returns light documents whose data and metadata reside on the
* underlaying {@link ByteBuf} until the entry is accesed.
*/
OFFHEAP(OFFHEAP_VALUES);
private final AllocationType lessRestrictive;
private AllocationType(AllocationType previous) {
this.lessRestrictive = previous;
}
@Nullable
public AllocationType getLessRestrictive() {
return lessRestrictive;
}
}
}
