Class Assert

The Assert class provides utility methods for assertion events.

Constructor Summary 

This class does not have a constructor, so you cannot create it directly.

Method Summary 
MethodDescription
static areEqual(Object, Object)Propagates an assertion if the specified objects are not equal.
static areEqual(Object, Object, String)Propagates an assertion using the specified message if the specified objects are not equal.
static areNotEqual(Object, Object)Propagates an assertion if the specified objects are equal.
static areNotEqual(Object, Object, String)Propagates an assertion using the specified message if the specified objects are equal.
static areSame(Object, Object)Propagates an assertion if the specified objects are not the same.
static areSame(Object, Object, String)Propagates an assertion using the specified message if the specified objects are not the same.
static fail()Propagates a failure assertion.
static fail(String)Propagates a failure assertion using the specified message.
static isEmpty(Object)Propagates an assertion if the specified check does not evaluate to an empty object.
static isEmpty(Object, String)Propagates an assertion using the specified message if the specified check does not evaluate to an empty object.
static isFalse(Boolean)Propagates an assertion if the specified check does not evaluate to false.
static isFalse(Boolean, String)Propagates an assertion using the specified message if the specified check does not evaluate to false.
static isInstanceOf(Object, Object)Propagates an assertion if the specified object ‘arg’ is not an instance of the specified class ‘clazz’.
static isInstanceOf(Object, Object, String)Propagates an assertion using the specified message if the specified object is not an instance of the specified class.
static isNotEmpty(Object)Propagates an assertion if the specified object is empty.
static isNotEmpty(Object, String)Propagates an assertion using the specified message if the specified object is empty.
static isNotNull(Object)Propagates an assertion if the specified object is null.
static isNotNull(Object, String)Propagates an assertion using the specified message if the specified object is null.
static isNull(Object)Propagates an assertion if the specified object is not null.
static isNull(Object, String)Propagates an assertion using the specified message if the specified object is not null.
static isTrue(Boolean)Propagates an assertion if the specified check does not evaluate to true.
static isTrue(Boolean, String)Propagates an assertion using the specified message if the specified check does not evaluate to true.

Methods inherited from class Object 

assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values

Method Details 

areEqual(Object, Object) 
static areEqual(arg1: Object, arg2: Object): void

Propagates an assertion if the specified objects are not equal.

Parameters:

  • arg1 - the first object to check.
  • arg2 - the second object to check.

areEqual(Object, Object, String) 
static areEqual(arg1: Object, arg2: Object, msg: String): void

Propagates an assertion using the specified message if the specified objects are not equal.

Parameters:

  • arg1 - the first object to check.
  • arg2 - the second object to check.
  • msg - the assertion message.

areNotEqual(Object, Object) 
static areNotEqual(arg1: Object, arg2: Object): void

Propagates an assertion if the specified objects are equal.

Parameters:

  • arg1 - the first object to check.
  • arg2 - the second object to check.

areNotEqual(Object, Object, String) 
static areNotEqual(arg1: Object, arg2: Object, msg: String): void

Propagates an assertion using the specified message if the specified objects are equal.

Parameters:

  • arg1 - the first object to check.
  • arg2 - the second object to check.
  • msg - the assertion message.

areSame(Object, Object) 
static areSame(arg1: Object, arg2: Object): void

Propagates an assertion if the specified objects are not the same.

Parameters:

  • arg1 - the first object to check.
  • arg2 - the second object to check.

areSame(Object, Object, String) 
static areSame(arg1: Object, arg2: Object, msg: String): void

Propagates an assertion using the specified message if the specified objects are not the same.

Parameters:

  • arg1 - the first object to check.
  • arg2 - the second object to check.
  • msg - the assertion message.

fail() 
static fail(): void

Propagates a failure assertion.

fail(String) 
static fail(msg: String): void

Propagates a failure assertion using the specified message.

Parameters:

  • msg - the assertion message.

isEmpty(Object) 
static isEmpty(arg: Object): void

Propagates an assertion if the specified check does not evaluate to an empty object.

Parameters:

  • arg - the object to check.

isEmpty(Object, String) 
static isEmpty(arg: Object, msg: String): void

Propagates an assertion using the specified message if the specified check does not evaluate to an empty object.

Parameters:

  • arg - the object to check.
  • msg - the assertion message.

isFalse(Boolean) 
static isFalse(check: Boolean): void

Propagates an assertion if the specified check does not evaluate to false.

Parameters:

  • check - the condition to check.

isFalse(Boolean, String) 
static isFalse(check: Boolean, msg: String): void

Propagates an assertion using the specified message if the specified check does not evaluate to false.

Parameters:

  • check - the condition to check.
  • msg - the assertion message.

isInstanceOf(Object, Object) 
static isInstanceOf(clazz: Object, arg: Object): void

Propagates an assertion if the specified object 'arg' is not an instance of the specified class 'clazz'.

For example, the following call does not propagate an assertion:

1var test = new dw.util.HashMap();
2    dw.util.Assert.isInstanceOf(dw.util.HashMap, test);

But the following call will propagate an assertion:

1var test = new dw.util.Set();
2    dw.util.Assert.isInstanceOf(dw.util.HashMap, test);

Note that 'clazz' can only be a Demandware API Scripting class.

Parameters:

  • clazz - the scripting class to use to check the object.
  • arg - the object to check.

isInstanceOf(Object, Object, String) 
static isInstanceOf(clazz: Object, arg: Object, msg: String): void

Propagates an assertion using the specified message if the specified object is not an instance of the specified class.

For example, the following call does not propagate an assertion:

1var test = new dw.util.HashMap();
2    dw.util.Assert.isInstanceOf(dw.util.HashMap, test);

But the following call will propagate an assertion:

1var test = new dw.util.Set();
2    dw.util.Assert.isInstanceOf(dw.util.HashMap, test);

Note that 'clazz' can only be a Demandware API Scripting class.

Parameters:

  • clazz - the scripting class to use to check the object.
  • arg - the object to check.
  • msg - the assertion message.

isNotEmpty(Object) 
static isNotEmpty(arg: Object): void

Propagates an assertion if the specified object is empty.

Parameters:

  • arg - the object to check.

isNotEmpty(Object, String) 
static isNotEmpty(arg: Object, msg: String): void

Propagates an assertion using the specified message if the specified object is empty.

Parameters:

  • arg - the object to check.
  • msg - the assertion message.

isNotNull(Object) 
static isNotNull(arg: Object): void

Propagates an assertion if the specified object is null.

Parameters:

  • arg - the object to check.

isNotNull(Object, String) 
static isNotNull(arg: Object, msg: String): void

Propagates an assertion using the specified message if the specified object is null.

Parameters:

  • arg - the object to check.
  • msg - the assertion message.

isNull(Object) 
static isNull(arg: Object): void

Propagates an assertion if the specified object is not null.

Parameters:

  • arg - the object to check.

isNull(Object, String) 
static isNull(arg: Object, msg: String): void

Propagates an assertion using the specified message if the specified object is not null.

Parameters:

  • arg - the object to check.
  • msg - the assertion message.

isTrue(Boolean) 
static isTrue(check: Boolean): void

Propagates an assertion if the specified check does not evaluate to true.

Parameters:

  • check - the condition to check.

isTrue(Boolean, String) 
static isTrue(check: Boolean, msg: String): void

Propagates an assertion using the specified message if the specified check does not evaluate to true.

Parameters:

  • check - the condition to check.
  • msg - the assertion message.

Open Commerce API (deprecated)
Shop Baskets (deprecated)
Shop Categories (deprecated)
Shop Content (deprecated)
Shop Content Search (deprecated)
Shop Custom Objects (deprecated)
Shop Customers (deprecated)
Shop Folders (deprecated)
Shop Gift Certificate (deprecated)
Shop Order Search (deprecated)
Shop Orders (deprecated)
Shop Price Adjustment Limits (deprecated)
Shop Product Lists (deprecated)
Shop Product Search (deprecated)
Shop Products (deprecated)
Shop Promotions (deprecated)
Shop Search Suggestion (deprecated)
Shop Sessions (deprecated)
Shop Site (deprecated)
Shop Stores (deprecated)
Data A/B Test Search (deprecated)
Data A/B Tests (deprecated)
Data Alerts (deprecated)
Data Campaign Search (deprecated)
Data Campaigns (deprecated)
Data Cartridges (deprecated)
Data Catalog Search (deprecated)
Data Catalogs (deprecated)
Data Category Search (deprecated)
Data Code Versions (deprecated)
Data Coupon Redemption Search (deprecated)
Data Coupon Search (deprecated)
Data Coupons (deprecated)
Data Custom Object Definitions (deprecated)
Data Custom Objects (deprecated)
Data Custom Objects Search (deprecated)
Data Customer Group Search (deprecated)
Data Customer Groups (deprecated)
Data Customer Lists (deprecated)
Data Gift Certificate Search (deprecated)
Data Gift Certificates (deprecated)
Data Global Custom Objects (deprecated)
Data Global Locale Info (deprecated)
Data Global Preferences (deprecated)
Data Global Site Preferences (deprecated)
Data Inventory List Search (deprecated)
Data Inventory Lists (deprecated)
Data Job Execution Search (deprecated)
Data Jobs (deprecated)
Data Libraries (deprecated)
Data Locale Info (deprecated)
Data Log Requests (deprecated)
Data Metrics (deprecated)
Data OCAPI Configs (deprecated)
Data Orders (deprecated)
Data Permissions (deprecated)
Data Product Search (deprecated)
Data Products (deprecated)
Data Promotion Campaign Assignment Search (deprecated)
Data Promotion Search (deprecated)
Data Promotions (deprecated)
Data Recommender Names (deprecated)
Data Role Search (deprecated)
Data Roles (deprecated)
Data Settings (deprecated)
Data Site Preferences (deprecated)
Data Site Search (deprecated)
Data Sites (deprecated)
Data Slot Configuration Campaign Assignment Search (deprecated)
Data Slot Configuration Search (deprecated)
Data Slot Configurations (deprecated)
Data Slot Search (deprecated)
Data Slots (deprecated)
Data Sorting Rule Search (deprecated)
Data Source Code Group Search (deprecated)
Data Source Code Groups (deprecated)
Data Store Search (deprecated)
Data Stores (deprecated)
Data System Object Definition Search (deprecated)
Data System Object Definitions (deprecated)
Data User Search (deprecated)
Data Users (deprecated)
Script API
B2C Commerce Script API 26.4
TopLevel
dw.alert
dw.campaign
dw.catalog
dw.content
dw.crypto
dw.customer
dw.customer.oauth
dw.customer.shoppercontext
dw.experience
dw.experience.cms
dw.experience.image
dw.extensions.applepay
dw.extensions.facebook
dw.extensions.paymentapi
dw.extensions.paymentrequest
dw.extensions.payments
dw.extensions.pinterest
dw.io
dw.job
dw.net
dw.object
dw.order
dw.order.hooks
dw.rpc
dw.sitemap
dw.suggest
dw.svc
dw.system
dw.template
dw.util
ArrayList
Assert
BigInteger
Bytes
Calendar
Collection
Currency
DateUtils
Decimal
FilteringCollection
Geolocation
HashMap
HashSet
Iterator
LinkedHashMap
LinkedHashSet
List
Locale
Map
MapEntry
MappingKey
MappingMgr
PropertyComparator
SecureEncoder
SecureFilter
SeekableIterator
Set
SortedMap
SortedSet
StringUtils
Template
UUIDUtils
dw.value
dw.web
dw.ws
B2C Commerce Developer Sandbox REST API

DID THIS ARTICLE SOLVE YOUR ISSUE?
Let us know so we can improve!