Skip to content

Commit

Permalink
javadoc update
Browse files Browse the repository at this point in the history
  • Loading branch information
cecemei committed Jan 10, 2025
1 parent 57574d6 commit b19f657
Showing 1 changed file with 6 additions and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,13 @@
import org.apache.druid.query.policy.Policy;

/**
* A {@link SegmentReference} wrapper with a {@link Policy} restriction that is not automatically enforced.
* Instead, it relies on the caller to apply or enforce the policy.
*
* <p>
* Certain methods, such as {@link #as(Class)}, {@link #asQueryableIndex()}, and {@link #asCursorFactory()},
* provide access to the underlying segment without automatically applying the policy, leaving it up to
* the caller to ensure compliance when needed.
* A {@link SegmentReference} wrapper with a {@link Policy} restriction that is not applied. Instead, it relies on the
* caller to apply the policy.
* <p>
* This design provides flexibility for scenarios where policy enforcement is not required or desired.
* This class is useful when a query engine needs direct access to interfaces that cannot have policies applied
* transparently. For example, {@link RestrictedSegment} returns null for {@link #asQueryableIndex} because it cannot
* apply policies transparently to a {@link QueryableIndex}. To use one, a query engine needs to obtain a
* {@link BypassRestrictedSegment} and apply the policies itself.
*/
class BypassRestrictedSegment extends WrappedSegmentReference
{
Expand Down

0 comments on commit b19f657

Please sign in to comment.