Class ConversionOptions


  • public class ConversionOptions
    extends java.lang.Object
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected ConversionOptions()  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      static ConversionOptions.ConversionOptionsBuilder conversionOptionsBuilder()  
      java.util.List<java.util.List<org.apache.olingo.odata2.api.uri.NavigationPropertySegment>> getExpand()  
      java.util.List<org.apache.olingo.odata2.api.uri.NavigationSegment> getNavigationSegments()  
      boolean isExpandPresent()
      Determines whether an expand option is present in this options.
      boolean isIncludeCollections()
      Deprecated, for removal: This API element is subject to removal in a future version.
      not used anymore, the solution is generalized for entities and collections.
      boolean isNavigationSegmentPresent()
      Determines whether navigation segments are present in this options.
      boolean isNextExpandSegment​(java.lang.String propertyName)
      Determines whether the specified property name is the next expand segment of this options.
      boolean isNextNavigationSegment​(java.lang.String propertyName)
      Determines whether the specified property name is the next navigation segment of this options.
      ConversionOptions navigate​(java.lang.String propertyName)
      Navigates the navigation segment.
      protected void setExpand​(java.util.List<java.util.List<org.apache.olingo.odata2.api.uri.NavigationPropertySegment>> expand)  
      protected void setIncludeCollections​(boolean includeCollections)
      Deprecated, for removal: This API element is subject to removal in a future version.
      not used anymore, the solution is generalized for entities and collections.
      protected void setNavigationSegments​(java.util.List<org.apache.olingo.odata2.api.uri.NavigationSegment> segments)  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • ConversionOptions

        protected ConversionOptions()
    • Method Detail

      • isIncludeCollections

        @Deprecated(since="1905.10-CEP",
                    forRemoval=true)
        public boolean isIncludeCollections()
        Deprecated, for removal: This API element is subject to removal in a future version.
        not used anymore, the solution is generalized for entities and collections.
        Determines whether collection conversion should be done.
        Returns:
        true, if nested collection(s) should be converted; false, otherwise.
      • setIncludeCollections

        @Deprecated(since="1905.10-CEP",
                    forRemoval=true)
        protected void setIncludeCollections​(boolean includeCollections)
        Deprecated, for removal: This API element is subject to removal in a future version.
        not used anymore, the solution is generalized for entities and collections.
        Specifies to include or exclude nested collections from further item grapsh references conversions.
        Parameters:
        includeCollections - true, if nested collection(s) should be converted; false, if not.
      • getNavigationSegments

        public java.util.List<org.apache.olingo.odata2.api.uri.NavigationSegment> getNavigationSegments()
      • setNavigationSegments

        protected void setNavigationSegments​(java.util.List<org.apache.olingo.odata2.api.uri.NavigationSegment> segments)
      • setExpand

        protected void setExpand​(java.util.List<java.util.List<org.apache.olingo.odata2.api.uri.NavigationPropertySegment>> expand)
      • getExpand

        public java.util.List<java.util.List<org.apache.olingo.odata2.api.uri.NavigationPropertySegment>> getExpand()
      • isNavigationSegmentPresent

        public boolean isNavigationSegmentPresent()
        Determines whether navigation segments are present in this options.
        Returns:
        true, if at least one navigation segment was added to this options; false, otherwise.
        See Also:
        setNavigationSegments(List)
      • isExpandPresent

        public boolean isExpandPresent()
        Determines whether an expand option is present in this options.
        Returns:
        true, if at least one nagivagtion property segment was added to this options; false, otherwise.
        See Also:
        setExpand(List)
      • navigate

        public ConversionOptions navigate​(java.lang.String propertyName)
        Navigates the navigation segment.
        Parameters:
        propertyName - name of the item property for the navigation segment to navigate.
        Returns:
        new instance of conversion of options without the consumed navigation segment or this options, if the navigation did not happen because the segment does not exist or the property name is invalid.
      • isNextNavigationSegment

        public boolean isNextNavigationSegment​(java.lang.String propertyName)
        Determines whether the specified property name is the next navigation segment of this options.
        Parameters:
        propertyName - name of the property to enquire about
        Returns:
        true, if next navigation segment in this options matches the property name; false, if next navigation segment in this options does not match the property name of when there are no navigation segments in this options.
      • isNextExpandSegment

        public boolean isNextExpandSegment​(java.lang.String propertyName)
        Determines whether the specified property name is the next expand segment of this options.
        Parameters:
        propertyName - name of the property to enquire about
        Returns:
        true, if next expand segment in this options matches the property name; false, if next expand segment in this options does not match the property name of when there are no expand segments in this options.