Package apple.foundation

Class NSURLComponents

    • Constructor Detail

      • NSURLComponents

        protected NSURLComponents​(org.moe.natj.general.Pointer peer)

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • allocWithZone

        public static NSURLComponents allocWithZone​(org.moe.natj.general.ptr.VoidPtr zone)

      • automaticallyNotifiesObserversForKey

        public static boolean automaticallyNotifiesObserversForKey​(@NotNull
                                                           @NotNull java.lang.String key)

      • cancelPreviousPerformRequestsWithTarget

        public static void cancelPreviousPerformRequestsWithTarget​(@NotNull
                                                           @NotNull java.lang.Object aTarget)

      • cancelPreviousPerformRequestsWithTargetSelectorObject

        public static void cancelPreviousPerformRequestsWithTargetSelectorObject​(@NotNull
                                                                         @NotNull java.lang.Object aTarget,
                                                                         @NotNull
                                                                         @NotNull org.moe.natj.objc.SEL aSelector,
                                                                         @Nullable
                                                                         @Nullable java.lang.Object anArgument)

      • classFallbacksForKeyedArchiver

        @NotNull
public static @NotNull NSArray<java.lang.String> classFallbacksForKeyedArchiver()

      • classForKeyedUnarchiver

        @NotNull
public static @NotNull org.moe.natj.objc.Class classForKeyedUnarchiver()

      • componentsWithString

        public static NSURLComponents componentsWithString​(@NotNull
                                                   @NotNull java.lang.String URLString)
        Initializes and returns a newly created NSURLComponents with a URL string. If the URLString is malformed, nil is returned.

      • componentsWithURLResolvingAgainstBaseURL

        public static NSURLComponents componentsWithURLResolvingAgainstBaseURL​(@NotNull
                                                                       @NotNull NSURL url,
                                                                       boolean resolve)
        Initializes and returns a newly created NSURLComponents with the components of a URL. If resolvingAgainstBaseURL is YES and url is a relative URL, the components of [url absoluteURL] are used. If the url string from the NSURL is malformed, nil is returned.

      • debugDescription_static

        public static java.lang.String debugDescription_static()

      • description_static

        public static java.lang.String description_static()

      • hash_static

        public static long hash_static()

      • instanceMethodSignatureForSelector

        public static NSMethodSignature instanceMethodSignatureForSelector​(org.moe.natj.objc.SEL aSelector)

      • instancesRespondToSelector

        public static boolean instancesRespondToSelector​(org.moe.natj.objc.SEL aSelector)

      • isSubclassOfClass

        public static boolean isSubclassOfClass​(org.moe.natj.objc.Class aClass)

      • keyPathsForValuesAffectingValueForKey

        @NotNull
public static @NotNull NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey​(@NotNull
                                                                                     @NotNull java.lang.String key)

      • resolveClassMethod

        public static boolean resolveClassMethod​(org.moe.natj.objc.SEL sel)

      • resolveInstanceMethod

        public static boolean resolveInstanceMethod​(org.moe.natj.objc.SEL sel)

      • setVersion_static

        public static void setVersion_static​(long aVersion)

      • superclass_static

        public static org.moe.natj.objc.Class superclass_static()

      • version_static

        public static long version_static()

      • URL

        @Nullable
public @Nullable NSURL URL()
        Returns a URL created from the NSURLComponents. If the NSURLComponents has an authority component (user, password, host or port) and a path component, then the path must either begin with "/" or be an empty string. If the NSURLComponents does not have an authority component (user, password, host or port) and has a path component, the path component must not start with "//". If those requirements are not met, nil is returned.

      • URLRelativeToURL

        @Nullable
public @Nullable NSURL URLRelativeToURL​(@Nullable
                                        @Nullable NSURL baseURL)
        Returns a URL created from the NSURLComponents relative to a base URL. If the NSURLComponents has an authority component (user, password, host or port) and a path component, then the path must either begin with "/" or be an empty string. If the NSURLComponents does not have an authority component (user, password, host or port) and has a path component, the path component must not start with "//". If those requirements are not met, nil is returned.

      • copyWithZone

        @NotNull
public @NotNull java.lang.Object copyWithZone​(@Nullable
                                              @Nullable org.moe.natj.general.ptr.VoidPtr zone)
        Specified by:
        copyWithZone in interface NSCopying

      • fragment

        @Nullable
public @Nullable java.lang.String fragment()

      • host

        @Nullable
public @Nullable java.lang.String host()

      • init

        public NSURLComponents init()
        Initialize a NSURLComponents with all components undefined. Designated initializer.
        Overrides:
        init in class NSObject

      • initWithString

        public NSURLComponents initWithString​(@NotNull
                                      @NotNull java.lang.String URLString)
        Initialize a NSURLComponents with a URL string. If the URLString is malformed, nil is returned.

      • initWithURLResolvingAgainstBaseURL

        public NSURLComponents initWithURLResolvingAgainstBaseURL​(@NotNull
                                                          @NotNull NSURL url,
                                                          boolean resolve)
        Initialize a NSURLComponents with the components of a URL. If resolvingAgainstBaseURL is YES and url is a relative URL, the components of [url absoluteURL] are used. If the url string from the NSURL is malformed, nil is returned.

      • password

        @Nullable
public @Nullable java.lang.String password()

      • path

        @Nullable
public @Nullable java.lang.String path()

      • percentEncodedFragment

        @Nullable
public @Nullable java.lang.String percentEncodedFragment()

      • percentEncodedHost

        @Nullable
@Deprecated
public @Nullable java.lang.String percentEncodedHost()
        Deprecated.
        API-Since: 7.0 Deprecated-Since: 100000.0 Deprecated-Message: Use encodedHost instead

      • percentEncodedPassword

        @Nullable
public @Nullable java.lang.String percentEncodedPassword()

      • percentEncodedPath

        @Nullable
public @Nullable java.lang.String percentEncodedPath()

      • percentEncodedQuery

        @Nullable
public @Nullable java.lang.String percentEncodedQuery()

      • percentEncodedUser

        @Nullable
public @Nullable java.lang.String percentEncodedUser()
        Getting these properties retains any percent encoding these components may have. Setting these properties assumes the component string is already correctly percent encoded. Attempting to set an incorrectly percent encoded string will cause an exception. Although ';' is a legal path character, it is recommended that it be percent-encoded for best compatibility with NSURL (-stringByAddingPercentEncodingWithAllowedCharacters: will percent-encode any ';' characters if you pass the URLPathAllowedCharacterSet).

      • port

        @Nullable
public @Nullable NSNumber port()
        Attempting to set a negative port number will cause an exception.

      • query

        @Nullable
public @Nullable java.lang.String query()

      • queryItems

        @Nullable
public @Nullable NSArray<? extends NSURLQueryItem> queryItems()
        The query component as an array of NSURLQueryItems for this NSURLComponents. Each NSURLQueryItem represents a single key-value pair, Note that a name may appear more than once in a single query string, so the name values are not guaranteed to be unique. If the NSURLComponents has an empty query component, returns an empty array. If the NSURLComponents has no query component, returns nil. The queryItems getter returns an array of NSURLQueryItems in the order in which they appear in the original query string. Any percent-encoding in a NSURLQueryItem name or value is removed. The queryItems setter combines an array containing any number of NSURLQueryItems, each of which represents a single key-value pair, into a query string and sets the NSURLComponents query property. If the NSURLQueryItems name or value strings contain any characters not allowed in a URL's query component, those characters are percent-encoded. In addition, any '&' and '=' characters in a NSURLQueryItem name are percent-encoded. Passing an empty array sets the query component of the NSURLComponents to an empty string. Passing nil removes the query component of the NSURLComponents. - note: If a NSURLQueryItem name-value pair is empty (i.e. the query string starts with '&', ends with '&', or has "&&" within it), you get a NSURLQueryItem with a zero-length name and a nil value. If a NSURLQueryItem name-value pair has nothing before the equals sign, you get a zero-length name. If a NSURLQueryItem name-value pair has nothing after the equals sign, you get a zero-length value. If a NSURLQueryItem name-value pair has no equals sign, the NSURLQueryItem name-value pair string is the name and you get a nil value. API-Since: 8.0

      • rangeOfFragment

        public NSRange rangeOfFragment()
        API-Since: 9.0

      • rangeOfHost

        public NSRange rangeOfHost()
        API-Since: 9.0

      • rangeOfPassword

        public NSRange rangeOfPassword()
        API-Since: 9.0

      • rangeOfPath

        public NSRange rangeOfPath()
        API-Since: 9.0

      • rangeOfPort

        public NSRange rangeOfPort()
        API-Since: 9.0

      • rangeOfQuery

        public NSRange rangeOfQuery()
        API-Since: 9.0

      • rangeOfScheme

        public NSRange rangeOfScheme()
        These properties return the character range of a component in the URL string returned by -[NSURLComponents string]. If the component does not exist in the NSURLComponents object, {NSNotFound, 0} is returned. Note: Zero length components are legal. For example, the URL string "scheme://:@/?#" has a zero length user, password, host, query and fragment; the URL strings "scheme:" and "" both have a zero length path. API-Since: 9.0

      • rangeOfUser

        public NSRange rangeOfUser()
        API-Since: 9.0

      • scheme

        @Nullable
public @Nullable java.lang.String scheme()
        Attempting to set the scheme with an invalid scheme string will cause an exception.

      • setFragment

        public void setFragment​(@Nullable
                        @Nullable java.lang.String value)

      • setHost

        public void setHost​(@Nullable
                    @Nullable java.lang.String value)

      • setPassword

        public void setPassword​(@Nullable
                        @Nullable java.lang.String value)

      • setPath

        public void setPath​(@Nullable
                    @Nullable java.lang.String value)

      • setPercentEncodedFragment

        public void setPercentEncodedFragment​(@Nullable
                                      @Nullable java.lang.String value)

      • setPercentEncodedHost

        @Deprecated
public void setPercentEncodedHost​(@Nullable
                                  @Nullable java.lang.String value)
        Deprecated.
        API-Since: 7.0 Deprecated-Since: 100000.0 Deprecated-Message: Use encodedHost instead

      • setPercentEncodedPassword

        public void setPercentEncodedPassword​(@Nullable
                                      @Nullable java.lang.String value)

      • setPercentEncodedPath

        public void setPercentEncodedPath​(@Nullable
                                  @Nullable java.lang.String value)

      • setPercentEncodedQuery

        public void setPercentEncodedQuery​(@Nullable
                                   @Nullable java.lang.String value)

      • setPercentEncodedUser

        public void setPercentEncodedUser​(@Nullable
                                  @Nullable java.lang.String value)
        Getting these properties retains any percent encoding these components may have. Setting these properties assumes the component string is already correctly percent encoded. Attempting to set an incorrectly percent encoded string will cause an exception. Although ';' is a legal path character, it is recommended that it be percent-encoded for best compatibility with NSURL (-stringByAddingPercentEncodingWithAllowedCharacters: will percent-encode any ';' characters if you pass the URLPathAllowedCharacterSet).

      • setPort

        public void setPort​(@Nullable
                    @Nullable NSNumber value)
        Attempting to set a negative port number will cause an exception.

      • setQuery

        public void setQuery​(@Nullable
                     @Nullable java.lang.String value)

      • setQueryItems

        public void setQueryItems​(@Nullable
                          @Nullable NSArray<? extends NSURLQueryItem> value)
        The query component as an array of NSURLQueryItems for this NSURLComponents. Each NSURLQueryItem represents a single key-value pair, Note that a name may appear more than once in a single query string, so the name values are not guaranteed to be unique. If the NSURLComponents has an empty query component, returns an empty array. If the NSURLComponents has no query component, returns nil. The queryItems getter returns an array of NSURLQueryItems in the order in which they appear in the original query string. Any percent-encoding in a NSURLQueryItem name or value is removed. The queryItems setter combines an array containing any number of NSURLQueryItems, each of which represents a single key-value pair, into a query string and sets the NSURLComponents query property. If the NSURLQueryItems name or value strings contain any characters not allowed in a URL's query component, those characters are percent-encoded. In addition, any '&' and '=' characters in a NSURLQueryItem name are percent-encoded. Passing an empty array sets the query component of the NSURLComponents to an empty string. Passing nil removes the query component of the NSURLComponents. - note: If a NSURLQueryItem name-value pair is empty (i.e. the query string starts with '&', ends with '&', or has "&&" within it), you get a NSURLQueryItem with a zero-length name and a nil value. If a NSURLQueryItem name-value pair has nothing before the equals sign, you get a zero-length name. If a NSURLQueryItem name-value pair has nothing after the equals sign, you get a zero-length value. If a NSURLQueryItem name-value pair has no equals sign, the NSURLQueryItem name-value pair string is the name and you get a nil value. API-Since: 8.0

      • setScheme

        public void setScheme​(@Nullable
                      @Nullable java.lang.String value)
        Attempting to set the scheme with an invalid scheme string will cause an exception.

      • setUser

        public void setUser​(@Nullable
                    @Nullable java.lang.String value)

      • string

        @Nullable
public @Nullable java.lang.String string()
        Returns a URL string created from the NSURLComponents. If the NSURLComponents has an authority component (user, password, host or port) and a path component, then the path must either begin with "/" or be an empty string. If the NSURLComponents does not have an authority component (user, password, host or port) and has a path component, the path component must not start with "//". If those requirements are not met, nil is returned. API-Since: 8.0

      • user

        @Nullable
public @Nullable java.lang.String user()

      • percentEncodedQueryItems

        @Nullable
public @Nullable NSArray<? extends NSURLQueryItem> percentEncodedQueryItems()
        The percentEncodedQueryItems getter returns an array of NSURLQueryItems in the order in which they appear in the original query string. Any percent-encoding in a NSURLQueryItem name or value is retained. The percentEncodedQueryItems setter combines an array containing any number of NSURLQueryItems, each of which represents a single key-value pair, into a query string and sets the NSURLComponents query property. This property assumes the NSURLQueryItem names and values are already correctly percent-encoded, and that the NSURLQueryItem names do not contain the query item delimiter characters '&' and '='. Attempting to set an incorrectly percent-encoded NSURLQueryItem or a NSURLQueryItem name with the query item delimiter characters '&' and '=' will cause an exception. API-Since: 11.0

      • setPercentEncodedQueryItems

        public void setPercentEncodedQueryItems​(@Nullable
                                        @Nullable NSArray<? extends NSURLQueryItem> value)
        The percentEncodedQueryItems getter returns an array of NSURLQueryItems in the order in which they appear in the original query string. Any percent-encoding in a NSURLQueryItem name or value is retained. The percentEncodedQueryItems setter combines an array containing any number of NSURLQueryItems, each of which represents a single key-value pair, into a query string and sets the NSURLComponents query property. This property assumes the NSURLQueryItem names and values are already correctly percent-encoded, and that the NSURLQueryItem names do not contain the query item delimiter characters '&' and '='. Attempting to set an incorrectly percent-encoded NSURLQueryItem or a NSURLQueryItem name with the query item delimiter characters '&' and '=' will cause an exception. API-Since: 11.0

      • encodedHost

        @Nullable
public @Nullable java.lang.String encodedHost()
        API-Since: 16.0

      • setEncodedHost

        public void setEncodedHost​(@Nullable
                           @Nullable java.lang.String value)
        API-Since: 16.0

      • componentsWithStringEncodingInvalidCharacters

        public static NSURLComponents componentsWithStringEncodingInvalidCharacters​(@NotNull
                                                                            @NotNull java.lang.String URLString,
                                                                            boolean encodingInvalidCharacters)
        Initializes and returns a newly created `NSURLComponents` with a URL string and the option to add (or skip) IDNA- and percent-encoding of invalid characters. If `encodingInvalidCharacters` is false, and the URL string is invalid according to RFC 3986, `nil` is returned. If `encodingInvalidCharacters` is true, `NSURLComponents` will try to encode the string to create a valid URL. If the URL string is still invalid after encoding, nil is returned. - Parameter URLString: The URL string. - Parameter encodingInvalidCharacters: True if `NSURLComponents` should try to encode an invalid URL string, false otherwise. - Returns: An `NSURLComponents` instance for a valid URL, or `nil` if the URL is invalid. API-Since: 17.0

      • initWithStringEncodingInvalidCharacters

        public NSURLComponents initWithStringEncodingInvalidCharacters​(@NotNull
                                                               @NotNull java.lang.String URLString,
                                                               boolean encodingInvalidCharacters)
        Initializes an `NSURLComponents` with a URL string and the option to add (or skip) IDNA- and percent-encoding of invalid characters. If `encodingInvalidCharacters` is false, and the URL string is invalid according to RFC 3986, `nil` is returned. If `encodingInvalidCharacters` is true, `NSURLComponents` will try to encode the string to create a valid URL. If the URL string is still invalid after encoding, `nil` is returned. - Parameter URLString: The URL string. - Parameter encodingInvalidCharacters: True if `NSURLComponents` should try to encode an invalid URL string, false otherwise. - Returns: An `NSURLComponents` instance for a valid URL, or `nil` if the URL is invalid. API-Since: 17.0

      • useStoredAccessor

        @Deprecated
public static boolean useStoredAccessor()
        Deprecated.