ch.trick17.betterchecks.fluent

Class UrlCheck

java.lang.Object

ch.trick17.betterchecks.fluent.BaseCheck<C>

ch.trick17.betterchecks.fluent.ObjectBaseCheck<URL,UrlCheck>

ch.trick17.betterchecks.fluent.UrlCheck

public final class UrlCheck
extends ObjectBaseCheck<URL,UrlCheck>

The check class for URL arguments.

It provides a quick method to assert a certain protocol ( hasProtocol(String)) and other than that provides property checks for all properties, including host, file, port, query, etc.

Author:

Michael Faes

Field Summary

Fields inherited from class ch.trick17.betterchecks.fluent.ObjectBaseCheck

arg, nullAllowed

Fields inherited from class ch.trick17.betterchecks.fluent.BaseCheck

argName, inverted

Constructor Summary

Constructors

Constructor and Description
UrlCheck(URL arg) For internal use only.

Method Summary

Modifier and Type	Method and Description
StringCheck	hasAuthorityWhich() Creates an StringCheck property check for the authority of the URL argument.
StringCheck	hasFileWhich() Creates an StringCheck property check for the file of the URL argument.
StringCheck	hasHostWhich() Creates an StringCheck property check for the host of the URL argument.
StringCheck	hasPathWhich() Creates an StringCheck property check for the path of the URL argument.
IntCheck	hasPortWhich() Creates an IntCheck property check for the port of the URL argument.
UrlCheck	hasProtocol(String protocol) Checks that the URL argument has the given protocol, throwing an exception otherwise.
StringCheck	hasProtocolWhich() Creates an StringCheck property check for the protocol of the URL argument.
StringCheck	hasQueryWhich() Creates an StringCheck property check for the query of the URL argument.
StringCheck	hasRefWhich() Creates an StringCheck property check for the reference (or the anchor) of the URL argument.
StringCheck	hasUserInfoWhich() Creates an StringCheck property check for the user info of the URL argument.

Methods inherited from class ch.trick17.betterchecks.fluent.ObjectBaseCheck

check, checkNull, checkWithCause, hasClass, intPropertyCheck, isEqualTo, isInstanceOf, isNotNull, isNullOr, isSameAs, objectPropertyCheck

Methods inherited from class ch.trick17.betterchecks.fluent.BaseCheck

checkConversion, me, named, not

Methods inherited from class java.lang.Object

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

Constructor Detail

UrlCheck

public UrlCheck(URL arg)

For internal use only.

Method Detail

hasProtocol

public UrlCheck hasProtocol(String protocol)

Checks that the URL argument has the given protocol, throwing an exception otherwise.

The message type used for exceptions thrown by this method is MessageType.ARG_PROTOCOL.

To create more sophisticated checks using the URL protocol, use the hasProtocolWhich() property check.

Parameters:

protocol - The protocol the URL should have

Returns:

This check

Throws:

IllegalArgumentException - if the URL argument has a protocol different from the given one

hasProtocolWhich

public StringCheck hasProtocolWhich()

Creates an StringCheck property check for the protocol of the URL argument. It can be used to create advanced checks using the protocol. For example:

Check.that(url).hasProtocolWhich().matches("https?");

Just like a check method, this method first asserts the non-nullness of the argument, throwing an exception in case of a failure.

The returned check has the protocol of this check's URL set as the argument and an argument name that indicates this fact. If the URL reference is null and allowed to be so (like in the above example), the returned property check is completely disabled, meaning none of its check methods will throw an exception. An inversion called before this method is ignored and does not have any effect on the check methods called on the returned property check.

Returns:

A property check for the protocol of the URL argument

hasHostWhich

public StringCheck hasHostWhich()

Creates an StringCheck property check for the host of the URL argument. It can be used to create checks using the host. For example:

Check.that(url).hasHostWhich().endsWith(".ch");

Just like a check method, this method first asserts the non-nullness of the argument, throwing an exception in case of a failure.

The returned check has the host of this check's URL set as the argument and an argument name that indicates this fact. If the URL reference is null and allowed to be so, the returned property check is completely disabled, meaning none of its check methods will throw an exception. An inversion called before this method is ignored and does not have any effect on the check methods called on the returned property check.

Returns:

A property check for the host of the URL argument

hasPortWhich

public IntCheck hasPortWhich()

Creates an IntCheck property check for the port of the URL argument. It can be used to create checks using the port. For example:

Check.that(url).hasPortWhich().is(80);

Just like a check method, this method first asserts the non-nullness of the argument, throwing an exception in case of a failure.

The returned check has the port of this check's URL set as the argument and an argument name that indicates this fact. If the URL reference is null and allowed to be so, the returned property check is completely disabled, meaning none of its check methods will throw an exception. An inversion called before this method is ignored and does not have any effect on the check methods called on the returned property check.

Returns:

A property check for the port of the URL argument

See Also:

URL.getPort()

hasFileWhich

public StringCheck hasFileWhich()

Creates an StringCheck property check for the file of the URL argument.

Just like a check method, this method first asserts the non-nullness of the argument, throwing an exception in case of a failure.

The returned check has the file of this check's URL set as the argument and an argument name that indicates this fact. If the URL reference is null and allowed to be so, the returned property check is completely disabled, meaning none of its check methods will throw an exception. An inversion called before this method is ignored and does not have any effect on the check methods called on the returned property check.

Returns:

A property check for the file of the URL argument

See Also:

URL.getFile()

hasQueryWhich

public StringCheck hasQueryWhich()

Creates an StringCheck property check for the query of the URL argument.

Just like a check method, this method first asserts the non-nullness of the argument, throwing an exception in case of a failure.

The returned check has the query of this check's URL set as the argument and an argument name that indicates this fact. If the URL reference is null and allowed to be so, the returned property check is completely disabled, meaning none of its check methods will throw an exception. An inversion called before this method is ignored and does not have any effect on the check methods called on the returned property check.

Returns:

A property check for the query of the URL argument

See Also:

URL.getQuery()

hasAuthorityWhich

public StringCheck hasAuthorityWhich()

Creates an StringCheck property check for the authority of the URL argument.

Just like a check method, this method first asserts the non-nullness of the argument, throwing an exception in case of a failure.

The returned check has the authority of this check's URL set as the argument and an argument name that indicates this fact. If the URL reference is null and allowed to be so, the returned property check is completely disabled, meaning none of its check methods will throw an exception. An inversion called before this method is ignored and does not have any effect on the check methods called on the returned property check.

Returns:

A property check for the authority of the URL argument

See Also:

URL.getAuthority()

hasPathWhich

public StringCheck hasPathWhich()

Creates an StringCheck property check for the path of the URL argument.

Just like a check method, this method first asserts the non-nullness of the argument, throwing an exception in case of a failure.

The returned check has the path of this check's URL set as the argument and an argument name that indicates this fact. If the URL reference is null and allowed to be so, the returned property check is completely disabled, meaning none of its check methods will throw an exception. An inversion called before this method is ignored and does not have any effect on the check methods called on the returned property check.

Returns:

A property check for the path of the URL argument

See Also:

URL.getPath()

hasUserInfoWhich

public StringCheck hasUserInfoWhich()

Creates an StringCheck property check for the user info of the URL argument.

Just like a check method, this method first asserts the non-nullness of the argument, throwing an exception in case of a failure.

The returned check has the user info of this check's URL set as the argument and an argument name that indicates this fact. If the URL reference is null and allowed to be so, the returned property check is completely disabled, meaning none of its check methods will throw an exception. An inversion called before this method is ignored and does not have any effect on the check methods called on the returned property check.

Returns:

A property check for the user info of the URL argument

See Also:

URL.getUserInfo()

hasRefWhich

public StringCheck hasRefWhich()

Creates an StringCheck property check for the reference (or the anchor) of the URL argument.

Just like a check method, this method first asserts the non-nullness of the argument, throwing an exception in case of a failure.

The returned check has the reference of this check's URL set as the argument and an argument name that indicates this fact. If the URL reference is null and allowed to be so, the returned property check is completely disabled, meaning none of its check methods will throw an exception. An inversion called before this method is ignored and does not have any effect on the check methods called on the returned property check.

Returns:

A property check for the reference of the URL argument

See Also:

URL.getRef()