com.github.dannil.scbjavaclient.utility

Class URLUtility

java.lang.Object

com.github.dannil.scbjavaclient.utility.URLUtility

public final class URLUtility
extends Object

Utility class which handles URL operations.

Since:

0.0.2

Method Summary

Modifier and Type	Method and Description
static String	changeLanguageForUrl(String url) Generates a new URL to the API using the fallback Locale FALLBACK_LOCALE.
static String	changeLanguageForUrl(String url, Locale locale) Generates a new URL to the API using the specified locale.
static String	changeLanguageForUrl(String url, String language) Generates a new URL to the API by replacing the current language tag in the URL with the specified language tag.
static String	getRootUrl() Returns the root URL for the API.
static String	getRootUrl(Locale locale) Returns the root URL for the API for a specific Locale.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getRootUrl

public static String getRootUrl()

Returns the root URL for the API.

Returns:

the ROOT_URL

getRootUrl

public static String getRootUrl(Locale locale)

Returns the root URL for the API for a specific Locale.

Parameters:

locale - the Locale

Returns:

the ROOT_URL with a converted language tag segment to match the specified Locale

changeLanguageForUrl

public static String changeLanguageForUrl(String url)

Generates a new URL to the API using the fallback Locale FALLBACK_LOCALE.

See changeLanguageForUrl(String, String) for implementation details.

Parameters:

url - the URL to edit

Returns:

the modified URL

changeLanguageForUrl

public static String changeLanguageForUrl(String url,
                                          Locale locale)

Generates a new URL to the API using the specified locale.

See changeLanguageForUrl(String, String) for implementation details.

Parameters:

url - the URL to edit

locale - the locale to use

Returns:

the modified URL

changeLanguageForUrl

public static String changeLanguageForUrl(String url,
                                          String language)

Generates a new URL to the API by replacing the current language tag in the URL with the specified language tag.

This method performs these steps to figure out what needs to be replaced:

1. Specifies the start segment as the segment preceding the language tag segment in the URL.
2. Finds the length of the language tag segment by finding the next forward slash following the start segment, as this indicates that the segment has ended.
3. Replaces the content between the start and end of the segment (forward slashes excluded) with the new language tag.

Due to speed efficiency, this method does not perform any validity check on the specified URL. Calling this method without a valid URL for the API may (and probably will) result in unexpected behavior.

Parameters:

url - the URL to edit

language - the language to use

Returns:

the modified URL