Skip to content

Ghidra is a software reverse engineering (SRE) framework

GP-0: Improving javadoc of OverlayAddressSpace.getAddress methods (Closes #9181)

Ryan Kurtzbe76bde4a2e0
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/OverlayAddressSpace.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/OverlayAddressSpace.java
index c631054478..b0b59e78f5 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/OverlayAddressSpace.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/OverlayAddressSpace.java
@@ -58,6 +58,12 @@ public abstract class OverlayAddressSpace extends AbstractAddressSpace {
return Objects.hash(orderedKey, baseSpace);
}
+ /**
+ * {@inheritDoc}
+ * <p>
+ * NOTE: This overridden method behaves like {@link #getAddress(long)}, not
+ * {@link #getAddressInThisSpaceOnly(long)}
+ */
@Override
public Address getAddress(String addrString, boolean caseSensitive)
throws AddressFormatException {
@@ -124,6 +130,12 @@ public abstract class OverlayAddressSpace extends AbstractAddressSpace {
return new GenericAddress(offset, this);
}
+ /**
+ * {@inheritDoc}
+ * <p>
+ * NOTE: If the offset is not contained in the bounds of the overlay region, the offset into the
+ * base space is returned.
+ */
@Override
public Address getAddress(long offset) {
if (contains(offset)) {