Mirrors_Framework/ghidra
1
0
Fork 0
mirror of https://github.com/NationalSecurityAgency/ghidra.git synced 2026-09-28 15:47:43 +08:00
Code Issues Packages Projects Releases Wiki Activity

GP-0: Fixing javadoc

Browse Source
This commit is contained in:
Ryan Kurtz
2026-06-04 06:11:57 -04:00
parent b66180204a
commit f51c930d7f
2 changed files with 12 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Ghidra/Framework/DB/src/main/java/db/buffers/BufferFileHandle.java
+6 -4
View File
@@ -18,6 +18,8 @@ package db.buffers;
import java.io.IOException;
import java.util.NoSuchElementException;
import ghidra.util.task.TaskMonitor;
/**
* <code>BufferFileHandle</code> facilitates access to a BufferFile
*/
@@ -102,14 +104,14 @@ public interface BufferFileHandle {
/**
* Provides local access to an input block stream. This method should only be used
* if the associated {@link BufferFileAdapter#isRemote()} is <i>false</i>.
* @see BufferFileAdapter#getInputBlockStream()
* @see BufferFileAdapter#getInputBlockStream(TaskMonitor)
*/
public InputBlockStream getInputBlockStream() throws IOException;
/**
* Provides local access to an output block stream. This method should only be used
* if the associated {@link BufferFileAdapter#isRemote()} is <i>false</i>.
* @see BufferFileAdapter#getOutputBlockStream(int)
* @see BufferFileAdapter#getOutputBlockStream(int, TaskMonitor)
*/
public OutputBlockStream getOutputBlockStream(int blockCount) throws IOException;
@@ -117,7 +119,7 @@ public interface BufferFileHandle {
* Get an input block stream handle which will facilitate access to a remote InputBlockStream.
* The handle will facilitate use of a remote streaming interface. This method should only be used
* if the associated {@link BufferFileAdapter#isRemote()} is <i>true</i>.
* @see BufferFileAdapter#getInputBlockStream()
* @see BufferFileAdapter#getInputBlockStream(TaskMonitor)
*/
public BlockStreamHandle<InputBlockStream> getInputBlockStreamHandle() throws IOException;
@@ -125,7 +127,7 @@ public interface BufferFileHandle {
* Get an output block stream handle which will facilitate access to a remote InputBlockStream.
* The handle will facilitate use of a remote streaming interface. This method should only be used
* if the associated {@link BufferFileAdapter#isRemote()} is <i>true</i>.
* @see BufferFileAdapter#getOutputBlockStream(int)
* @see BufferFileAdapter#getOutputBlockStream(int, TaskMonitor)
*/
public BlockStreamHandle<OutputBlockStream> getOutputBlockStreamHandle(int blockCount)
throws IOException;
Ghidra/Framework/DB/src/main/java/db/buffers/ManagedBufferFileHandle.java
+6 -4
View File
@@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -17,6 +17,8 @@ package db.buffers;
import java.io.IOException;
import ghidra.util.task.TaskMonitor;
/**
* <code>ManagedBufferFileHandle</code> facilitates access to a ManagedBufferFile
*/
@@ -66,7 +68,7 @@ public interface ManagedBufferFileHandle extends BufferFileHandle {
* Provides local access to an input block stream for a given change map.
* This method should only be used if the associated
* {@link BufferFileAdapter#isRemote()} is <i>false</i>.
* @see ManagedBufferFileAdapter#getInputBlockStream(byte[])
* @see ManagedBufferFileAdapter#getInputBlockStream(byte[], TaskMonitor)
*/
public InputBlockStream getInputBlockStream(byte[] changeMapData) throws IOException;
@@ -75,7 +77,7 @@ public interface ManagedBufferFileHandle extends BufferFileHandle {
* access to a remote InputBlockStream. The handle will facilitate use of a
* remote streaming interface. This method should only be used
* if the associated {@link BufferFileAdapter#isRemote()} is <i>true</i>.
* @see ManagedBufferFileAdapter#getInputBlockStream(byte[])
* @see ManagedBufferFileAdapter#getInputBlockStream(byte[], TaskMonitor)
*/
public BlockStreamHandle<InputBlockStream> getInputBlockStreamHandle(byte[] changeMapData)
throws IOException;