public interface URIBuilder
| Modifier and Type | Method and Description |
|---|---|
URIBuilder |
addCustomQueryOption(String customName,
String customValue)
Adds/Replaces the specified custom query option to the URI.
|
URIBuilder |
addParameterAlias(String alias,
String exp)
Adds the specified (custom) parameter alias to the URI.
|
URIBuilder |
addQueryOption(QueryOption option,
String value)
Adds the specified query option to the URI.
|
URIBuilder |
addQueryOption(String option,
String value,
boolean replace)
Adds/Replaces the specified (custom) query option to the URI.
|
URIBuilder |
appendActionCallSegment(String action)
Appends action segment to the URI.
|
URIBuilder |
appendAllSegment()
Appends all segment to the URI.
|
URIBuilder |
appendBatchSegment()
Appends batch segment to the URI.
|
URIBuilder |
appendCountSegment()
Appends count segment to the URI.
|
URIBuilder |
appendCrossjoinSegment(String... segmentValues)
Appends cross join segment to the URI.
|
URIBuilder |
appendDerivedEntityTypeSegment(String segmentValue)
Appends derived entity type segment to the URI.
|
URIBuilder |
appendEntityIdSegment(String segmentValue)
Appends entity-id segment to the URI.
|
URIBuilder |
appendEntitySetSegment(String segmentValue)
Appends EntitySet segment to the URI.
|
URIBuilder |
appendKeySegment(EdmEnumType enumType,
String memberName)
Appends enum key segment to the URI.
|
URIBuilder |
appendKeySegment(Map<String,Object> segmentValues)
Appends key segment to the URI, for multiple keys.
|
URIBuilder |
appendKeySegment(Map<String,org.apache.commons.lang3.tuple.Pair<EdmEnumType,String>> enumValues,
Map<String,Object> segmentValues)
Appends key segment to the URI, for multiple keys.
|
URIBuilder |
appendKeySegment(Object val)
Appends key segment to the URI.
|
URIBuilder |
appendMetadataSegment()
Appends metadata segment to the URI.
|
URIBuilder |
appendNavigationSegment(String segmentValue)
Appends navigation segment to the URI.
|
URIBuilder |
appendOperationCallSegment(String operation)
Appends operation (action or function) segment to the URI.
|
URIBuilder |
appendPropertySegment(String segmentValue)
Appends property segment to the URI.
|
URIBuilder |
appendRefSegment()
Appends ref segment to the URI.
|
URIBuilder |
appendSingletonSegment(String segmentValue)
Appends Singleton segment to the URI.
|
URIBuilder |
appendValueSegment()
Appends value segment to the URI.
|
URI |
build()
Build OData URI.
|
URIBuilder |
count()
Adds count query option.
|
URIBuilder |
count(boolean value)
Appends count query option.
|
URIBuilder |
expand(String... expandItems)
Adds expand query option.
|
URIBuilder |
expandWithOptions(String expandItem,
boolean pathRef,
boolean pathCount,
Map<QueryOption,Object> options)
The set of expanded entities can be refined through the application of expand options, expressed as a
semicolon-separated list of system query options, enclosed in parentheses, see [OData-URL].
|
URIBuilder |
expandWithOptions(String expandItem,
Map<QueryOption,Object> options)
The set of expanded entities can be refined through the application of expand options, expressed as a
semicolon-separated list of system query options, enclosed in parentheses, see [OData-URL].
|
URIBuilder |
expandWithSelect(String expandItem,
String... selectItems)
Properties of related entities can be specified by including the $select query option within the $expand.
|
URIBuilder |
filter(String filter)
Adds filter query option.
|
URIBuilder |
filter(URIFilter filter)
Adds filter for filter query option.
|
URIBuilder |
format(String format)
Adds format query option.
|
URIBuilder |
id(String idValue)
Adds id query option.
|
URIBuilder |
orderBy(String order)
Adds orderby query option.
|
URIBuilder |
replaceQueryOption(QueryOption option,
String value)
Adds/replaces the specified query option to the URI.
|
URIBuilder |
search(String expression)
Appends search query option.
|
URIBuilder |
search(URISearch search)
Appends search query option.
|
URIBuilder |
select(String... selectItems)
Adds select query option.
|
URIBuilder |
skip(int skip)
Adds skip query option.
|
URIBuilder |
skipToken(String skipToken)
Adds skiptoken query option.
|
URIBuilder |
top(int top)
Adds top query option.
|
URIBuilder addQueryOption(QueryOption option, String value)
option - query option.value - query option value.URIBuilder replaceQueryOption(QueryOption option, String value)
option - query option.value - query option value.URIBuilder addQueryOption(String option, String value, boolean replace)
option - query option.value - query option value.replace - if true then replace existing one.URIBuilder addParameterAlias(String alias, String exp)
alias - parameter alias.exp - expression value.URIBuilder appendEntitySetSegment(String segmentValue)
segmentValue - segment value.URIBuilder appendKeySegment(Object val)
val - segment value.URIBuilder appendKeySegment(Map<String,Object> segmentValues)
segmentValues - segment values.URIBuilder appendPropertySegment(String segmentValue)
segmentValue - segment value.URIBuilder appendNavigationSegment(String segmentValue)
segmentValue - segment value.URIBuilder appendDerivedEntityTypeSegment(String segmentValue)
segmentValue - segment value.URIBuilder appendValueSegment()
URIBuilder appendCountSegment()
URIBuilder appendOperationCallSegment(String operation)
operation - Operation (action or function) nameURIBuilder appendMetadataSegment()
URIBuilder appendBatchSegment()
URIBuilder count()
URIBuilder expand(String... expandItems)
expandItems - items to be expanded in-lineQueryOption.EXPANDURIBuilder format(String format)
format - media type acceptable in a response.QueryOption.FORMATURIBuilder filter(URIFilter filter)
filter - filter instance (to be obtained via FilterFactory);
note that build() method will be immediately invoked.QueryOption.FILTER,
URIFilter,
FilterFactoryURIBuilder filter(String filter)
filter - filter string.QueryOption.FILTERURIBuilder select(String... selectItems)
selectItems - select itemsQueryOption.SELECTURIBuilder orderBy(String order)
order - order string.QueryOption.ORDERBYURIBuilder top(int top)
top - maximum number of entities to be returned.QueryOption.TOPURIBuilder skip(int skip)
skip - number of entities to be skipped into the response.QueryOption.SKIPURIBuilder skipToken(String skipToken)
skipToken - opaque token.QueryOption.SKIPTOKENURI build()
URIBuilder appendKeySegment(EdmEnumType enumType, String memberName)
enumType - enum typememberName - enum member nameURIBuilder appendKeySegment(Map<String,org.apache.commons.lang3.tuple.Pair<EdmEnumType,String>> enumValues, Map<String,Object> segmentValues)
enumValues - enum segment values.segmentValues - segment values.URIBuilder appendSingletonSegment(String segmentValue)
segmentValue - segment value.URIBuilder appendEntityIdSegment(String segmentValue)
segmentValue - segment valueURIBuilder appendRefSegment()
URIBuilder appendCrossjoinSegment(String... segmentValues)
segmentValues - segment values.URIBuilder appendAllSegment()
URIBuilder id(String idValue)
idValue - opaque token.QueryOption.IDURIBuilder count(boolean value)
value - true or falseQueryOption.COUNTURIBuilder search(URISearch search)
search - search expressionQueryOption.SEARCHURIBuilder search(String expression)
expression - search expressionQueryOption.SEARCHURIBuilder expandWithOptions(String expandItem, Map<QueryOption,Object> options)
expandItem - item to be expanded.options - System query options. Allowed query options are: $filter, $select, $orderby, $skip, $top, $count,
$search, $expand, and $levels.QueryOption.EXPANDURIBuilder expandWithOptions(String expandItem, boolean pathRef, boolean pathCount, Map<QueryOption,Object> options)
expandItem - item to be expanded.pathRef - include the /$ref at the end of the $expand item's path;if true pathCount MUST be falsepathCount - include /$count at the end of the $expand item's path;if true pathRef MUST be falseoptions - System query options. Allowed query options are: $filter, $select, $orderby, $skip, $top, $count,
$search, $expand, and $levels.QueryOption.EXPANDURIBuilder expandWithSelect(String expandItem, String... selectItems)
expandItem - related entity name.selectItems - properties to be selected.QueryOption.EXPAND,
QueryOption.SELECTURIBuilder appendActionCallSegment(String action)
action - Action nameURIBuilder addCustomQueryOption(String customName, String customValue)
option. - value. - Copyright © 2013–2023 The Apache Software Foundation. All rights reserved.