ShouldExtensions (SARL Agent Oriented Programming Language 0.12.0 API)

```
public final class ShouldExtensions
extends Object
```
Should functions for the documentation facts.

Since:

0.6

Version:

io.sarl.maven.docs.testing 0.12.0 20210527-171007

Author:

Stéphane Galland

Maven Group Id:

io.sarl.maven

Maven Artifact Id:

io.sarl.maven.docs.testing

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ShouldExtensions.ShouldException
Major exception in a should function.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ShouldExtensions.ShouldException` Major exception in a should function.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static <K,V> boolean`	`shouldBe(map : Map<K,V>, reference : Map<? super K,? super V>)` Ensure that the given map contains the elements.
`static boolean`	`shouldBe(actual : org.eclipse.xtext.xbase.XBooleanLiteral, expected : Object)` Ensure that the given boolean literal is equal to the given value.
`static boolean`	`shouldBe(actual : org.eclipse.xtext.xbase.XCollectionLiteral, expected : Object)` Ensure that the given type literal is equal to the given list.
`static boolean`	`shouldBe(actual : org.eclipse.xtext.xbase.XNumberLiteral, expected : Object)` Ensure that the given number literal is equal to the given value.
`static boolean`	`shouldBe(actual : org.eclipse.xtext.xbase.XStringLiteral, expected : Object)` Ensure that the given string literal is equal to the given value.
`static boolean`	`shouldBe(actual : org.eclipse.xtext.xbase.XTypeLiteral, expected : Object)` Ensure that the given type literal is equal to the given type.
`static boolean`	`shouldBeApiURL(actual : String, allowedAPIhostname : String)` Ensure that the string has the format of an URL to the SARL API.
`static boolean`	`shouldBeAtLeastJava(minVersion : String)` Ensure that the version of the current Java specification is at least the one given by minVersion.
`static boolean`	`shouldBeDate(actual : String)` Ensure that the string has the format of a date.
`static boolean`	`shouldBeDate(actual : String, dateFormat : String)` Ensure that the string has the format of a date.
`static boolean`	`shouldBeHiddenName(string : String)` Ensure that the given string is an hidden name according to the SARL specification.
`static boolean`	`shouldBeJavaRange(minVersion : String, maxVersion : String)` Ensure that the version of the current Java specification is in the range given by the minVersion (inclusive) and maxVersion (exclusive).
`static boolean`	`shouldBeLiteral(actual : org.eclipse.xtext.xbase.XExpression, expected : Object)` Ensure that the given type literal is equal to the given type.
`static boolean`	`shouldBeMavenVersion(actual : String)` Ensure that the given string is a valid Maven version number, including snapshot.
`static boolean`	`shouldBeMavenVersion(actual : String, allowSnapshot : boolean)` Ensure that the given string is a valid Maven version number.
`static boolean`	`shouldBeNumber(actual : String)` Ensure that the string has the format of a number.
`static boolean`	`shouldBeNumber(actual : String, numberFormat : String)` Ensure that the string has the format of a number.
`static boolean`	`shouldExtend(type : Class<?>, expectedTypes : String)` Ensure that the given type extends specific types.
`static Field`	`shouldHaveDeprecatedField(type : Class<?>, name : String)` Ensure that the given type has the given type has the given deprecated field.
`static Method`	`shouldHaveDeprecatedMethod(type : Class<?>, name : String)` Ensure that the given type has the given deprecated method.
`static Field`	`shouldHaveField(type : Class<?>, name : String)` Ensure that the given type has the given type has the given field.
`protected static Field`	`shouldHaveField(type : Class<?>, name : String, deprecated : boolean)` Ensure that the given type has the given type has the given method.
`static Method`	`shouldHaveMethod(type : Class<?>, name : String)` Ensure that the given type has the given method.
`protected static Method`	`shouldHaveMethod(type : Class<?>, name : String, deprecated : boolean)` Ensure that the given type has the given method.
`static boolean`	`shouldHaveMethods(type : Class<?>, considerHiddenNames : boolean, prototypes : String*)` Ensure that the given type has the given methods.
`static boolean`	`shouldHaveMethods(type : Class<?>, prototypes : String*)` Ensure that the given type has the given methods.
`static boolean`	`shouldHaveNbMembers(type : Class<?>, expectedNbOfElements : int)` Ensure that the given type has the number of members.
`static boolean`	`shouldHaveProperty(propertyFile : URL, property : org.eclipse.xtext.xbase.lib.Pair<String,String>)` Ensure that the given URL is a property file with the given property.
`static boolean`	`shouldHaveProperty(propertyFile : URL, propertyName : String)` Ensure that the given URL is a property file with the given property name.
`static boolean`	`shouldIterate(actual : Iterator<?>, expected : Object)` Ensure that the iterator replies the expected values in the given order.
`static boolean`	`shouldIterate(actual : Iterator<?>, expected : Object, significantOrder : boolean)` Ensure that the iterator replies the expected values in the given order.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - shouldBeDate
```
public static def shouldBeDate(actual : String,
                               dateFormat : String) : boolean 
```
    Description copied from class: ShouldExtensions
    
    Ensure that the string has the format of a date.
    
    Parameters:
    
    actual - the string to parse.
    
    dateFormat - the expected format of the date, as described in SimpleDateFormat. If null, the default date format is considered.
    
    Returns:
    
    the validation status
  - shouldBeDate
```
public static def shouldBeDate(actual : String) : boolean 
```
    Description copied from class: ShouldExtensions
    
    Ensure that the string has the format of a date.
    
    Parameters:
    
    actual - the string to parse.
    
    Returns:
    
    the validation status
  - shouldBeNumber
```
public static def shouldBeNumber(actual : String,
                                 numberFormat : String) : boolean 
```
    Description copied from class: ShouldExtensions
    
    Ensure that the string has the format of a number.
    
    Parameters:
    
    actual - the string to parse.
    
    numberFormat - the expected format of the number, as described in DecimalFormat. If null, the default date format is considered.
    
    Returns:
    
    the validation status
  - shouldBeNumber
```
public static def shouldBeNumber(actual : String) : boolean 
```
    Description copied from class: ShouldExtensions
    
    Ensure that the string has the format of a number.
    
    Parameters:
    
    actual - the string to parse.
    
    Returns:
    
    the validation status
  - shouldBeMavenVersion
```
public static def shouldBeMavenVersion(actual : String,
                                       allowSnapshot : boolean) : boolean 
```
    Description copied from class: ShouldExtensions
    
    Ensure that the given string is a valid Maven version number.
    
    Parameters:
    
    actual - the string to test.
    
    allowSnapshot - indicates if the -SNAPSHOT postfix is considered as valid.
    
    Returns:
    
    the validation status.
  - shouldBeMavenVersion
```
public static def shouldBeMavenVersion(actual : String) : boolean 
```
    Description copied from class: ShouldExtensions
    
    Ensure that the given string is a valid Maven version number, including snapshot.
    
    Parameters:
    
    actual - the string to test.
    
    Returns:
    
    the validation status.
  - shouldBeJavaRange
```
public static def shouldBeJavaRange(minVersion : String,
                                    maxVersion : String) : boolean 
```
    Description copied from class: ShouldExtensions
    
    Ensure that the version of the current Java specification is in the range given by the minVersion (inclusive) and maxVersion (exclusive). If the maxVersion is not given or is not a properly formated version number, then all versions after the minVersion are valid.
    
    Parameters:
    
    minVersion - the minimal version.
    
    maxVersion - the maximal version.
    
    Returns:
    
    the validation status.
  - shouldBeAtLeastJava
```
public static def shouldBeAtLeastJava(minVersion : String) : boolean 
```
    Description copied from class: ShouldExtensions
    
    Ensure that the version of the current Java specification is at least the one given by minVersion.
    
    Parameters:
    
    minVersion - the minimal version.
    
    Returns:
    
    the validation status.
  - shouldIterate
```
public static def shouldIterate(actual : Iterator<?>,
                                expected : Object) : boolean 
```
    Description copied from class: ShouldExtensions
    
    Ensure that the iterator replies the expected values in the given order.
    
    Parameters:
    
    actual - the iterator to test.
    
    expected - the expected values.
    
    Returns:
    
    the validation status
  - shouldIterate
```
public static def shouldIterate(actual : Iterator<?>,
                                expected : Object,
                                significantOrder : boolean) : boolean 
```
    Description copied from class: ShouldExtensions
    
    Ensure that the iterator replies the expected values in the given order.
    
    Parameters:
    
    actual - the iterator to test.
    
    expected - the expected values.
    
    significantOrder - indicates if the order of the elements is significant.
    
    Returns:
    
    the validation status
  - shouldBeApiURL
```
public static def shouldBeApiURL(actual : String,
                                 allowedAPIhostname : String) : boolean 
```
    Description copied from class: ShouldExtensions
    
    Ensure that the string has the format of an URL to the SARL API.
    
    Parameters:
    
    actual - the string to parse.
    
    allowedAPIhostname - is a list of API base hostname to consider as valid. If not given, only "www.sarl.io" is allowed.
    
    Returns:
    
    the validation status
  - shouldBe
```
public static def shouldBe(actual : org.eclipse.xtext.xbase.XStringLiteral,
                           expected : Object) : boolean 
```
    Description copied from class: ShouldExtensions
    
    Ensure that the given string literal is equal to the given value.
    
    Parameters:
    
    actual - the string literal to test.
    
    expected - the expected value.
    
    Returns:
    
    the validation status
  - shouldBe
```
public static def shouldBe(actual : org.eclipse.xtext.xbase.XBooleanLiteral,
                           expected : Object) : boolean 
```
    Description copied from class: ShouldExtensions
    
    Ensure that the given boolean literal is equal to the given value.
    
    Parameters:
    
    actual - the boolean literal to test.
    
    expected - the expected value.
    
    Returns:
    
    the validation status
  - shouldBe
```
public static def shouldBe(actual : org.eclipse.xtext.xbase.XNumberLiteral,
                           expected : Object) : boolean 
```
    Description copied from class: ShouldExtensions
    
    Ensure that the given number literal is equal to the given value.
    
    Parameters:
    
    actual - the number literal to test.
    
    expected - the expected value.
    
    Returns:
    
    the validation status
  - shouldBe
```
public static def shouldBe(actual : org.eclipse.xtext.xbase.XTypeLiteral,
                           expected : Object) : boolean 
```
    Description copied from class: ShouldExtensions
    
    Ensure that the given type literal is equal to the given type.
    
    Parameters:
    
    actual - the type literal to test.
    
    expected - the name of the expected type.
    
    Returns:
    
    the validation status
  - shouldBe
```
public static def shouldBe(actual : org.eclipse.xtext.xbase.XCollectionLiteral,
                           expected : Object) : boolean 
```
    Description copied from class: ShouldExtensions
    
    Ensure that the given type literal is equal to the given list.
    
    Parameters:
    
    actual - the type literal to test.
    
    expected - the name of the expected type.
    
    Returns:
    
    the validation status
  - shouldBeLiteral
```
public static def shouldBeLiteral(actual : org.eclipse.xtext.xbase.XExpression,
                                  expected : Object) : boolean 
```
    Description copied from class: ShouldExtensions
    
    Ensure that the given type literal is equal to the given type.
    
    Parameters:
    
    actual - the type literal to test.
    
    expected - the name of the expected type.
    
    Returns:
    
    the validation status
  - shouldHaveDeprecatedMethod
```
public static def shouldHaveDeprecatedMethod(type : Class<?>,
                                             name : String) : Method 
```
    Description copied from class: ShouldExtensions
    Ensure that the given type has the given deprecated method. The format of the name may be:
    - ID
    - ID(TYPE, TYPE...)
    - ID : TYPE
    - ID(TYPE, TYPE...) : TYPE
    Parameters:
    
    type - the type to check.
    
    name - the name and prototype, e.g. fct(java.lang.String):int.
    
    Returns:
    
    the method.
  - shouldHaveMethod
```
public static def shouldHaveMethod(type : Class<?>,
                                   name : String) : Method 
```
    Description copied from class: ShouldExtensions
    Ensure that the given type has the given method. The format of the name may be:
    - ID
    - ID(TYPE, TYPE...)
    - ID : TYPE
    - ID(TYPE, TYPE...) : TYPE
    Parameters:
    
    type - the type to check.
    
    name - the name and prototype, e.g. fct(java.lang.String):int.
    
    Returns:
    
    the method.
  - shouldHaveMethod
```
protected static def shouldHaveMethod(type : Class<?>,
                                      name : String,
                                      deprecated : boolean) : Method 
```
    Description copied from class: ShouldExtensions
    Ensure that the given type has the given method. The format of the name may be:
    - ID
    - ID(TYPE, TYPE...)
    - ID : TYPE
    - ID(TYPE, TYPE...) : TYPE
    Parameters:
    
    type - the type to check.
    
    name - the name and prototype, e.g. fct(java.lang.String):int.
    
    deprecated - indicates if the field must be deprecated.
    
    Returns:
    
    the method.
  - shouldHaveMethods
```
public static def shouldHaveMethods(type : Class<?>,
                                    prototypes : String*) : boolean 
```
    Description copied from class: ShouldExtensions
    Ensure that the given type has the given methods. The format of the prototypes may be:
    - ID
    - ID(TYPE, TYPE...)
    - ID : TYPE
    - ID(TYPE, TYPE...) : TYPE
    The methods with hidden names according to SARL are not considered.
    Parameters:
    
    type - the type to check.
    
    prototypes - the prototypes, e.g. fct(java.lang.String):int.
    
    Returns:
    
    the validation status.
  - shouldHaveMethods
```
public static def shouldHaveMethods(type : Class<?>,
                                    considerHiddenNames : boolean,
                                    prototypes : String*) : boolean 
```
    Description copied from class: ShouldExtensions
    Ensure that the given type has the given methods. The format of the prototypes may be:
    - ID
    - ID(TYPE, TYPE...)
    - ID : TYPE
    - ID(TYPE, TYPE...) : TYPE
    Parameters:
    
    type - the type to check.
    
    considerHiddenNames - indicates if the methods with hidden names are considered.
    
    prototypes - the prototypes, e.g. fct(java.lang.String):int.
    
    Returns:
    
    the validation status.
    
    Since:
    
    0.12
  - shouldBeHiddenName
```
public static def shouldBeHiddenName(string : String) : boolean 
```
    Description copied from class: ShouldExtensions
    
    Ensure that the given string is an hidden name according to the SARL specification.
    
    Parameters:
    
    string - the text to validate.
    
    Returns:
    
    true if the given string is an hidden name.
    
    Since:
    
    0.12
  - shouldHaveDeprecatedField
```
public static def shouldHaveDeprecatedField(type : Class<?>,
                                            name : String) : Field 
```
    Description copied from class: ShouldExtensions
    Ensure that the given type has the given type has the given deprecated field. The format of the name may be:
    - ID
    - ID : TYPE
    Parameters:
    
    type - the type to check.
    
    name - the name and prototype, e.g. x:int.
    
    Returns:
    
    the field.
  - shouldHaveField
```
public static def shouldHaveField(type : Class<?>,
                                  name : String) : Field 
```
    Description copied from class: ShouldExtensions
    Ensure that the given type has the given type has the given field. The format of the name may be:
    - ID
    - ID : TYPE
    Parameters:
    
    type - the type to check.
    
    name - the name and prototype, e.g. x:int.
    
    Returns:
    
    the field.
  - shouldHaveField
```
protected static def shouldHaveField(type : Class<?>,
                                     name : String,
                                     deprecated : boolean) : Field 
```
    Description copied from class: ShouldExtensions
    Ensure that the given type has the given type has the given method. The format of the name may be:
    - ID
    - ID : TYPE
    Parameters:
    
    type - the type to check.
    
    name - the name and prototype, e.g. x:int.
    
    deprecated - indicates if the field must be deprecated.
    
    Returns:
    
    the field.
  - shouldExtend
```
public static def shouldExtend(type : Class<?>,
                               expectedTypes : String) : boolean 
```
    Description copied from class: ShouldExtensions
    
    Ensure that the given type extends specific types.
    
    Parameters:
    
    type - the type to check.
    
    expectedTypes - the qualified names of the expected types, separated by comas.
    
    Returns:
    
    the validation status.
  - shouldHaveNbMembers
```
public static def shouldHaveNbMembers(type : Class<?>,
                                      expectedNbOfElements : int) : boolean 
```
    Description copied from class: ShouldExtensions
    
    Ensure that the given type has the number of members.
    
    Parameters:
    
    type - the type to check.
    
    expectedNbOfElements - the expected number of elements.
    
    Returns:
    
    the validation status.
  - shouldBe
```
public static def shouldBe(map : Map<K,V>,
                           reference : Map<? super K,? super V>) : boolean  with <K,V> 
```
    Description copied from class: ShouldExtensions
    
    Ensure that the given map contains the elements.
    
    Type Parameters:
    
    K - type of the keys.
    
    V - type of the values.
    
    Parameters:
    
    map - the map to check.
    
    reference - the expected elements in the map.
    
    Returns:
    
    the validation status.
  - shouldHaveProperty
```
public static def shouldHaveProperty(propertyFile : URL,
                                     propertyName : String) : boolean 
```
    Description copied from class: ShouldExtensions
    
    Ensure that the given URL is a property file with the given property name.
    
    Parameters:
    
    propertyFile - the name of the property file.
    
    propertyName - the name of the property name.
    
    Returns:
    
    the validation status.
  - shouldHaveProperty
```
public static def shouldHaveProperty(propertyFile : URL,
                                     property : org.eclipse.xtext.xbase.lib.Pair<String,String>) : boolean 
```
    Description copied from class: ShouldExtensions
    
    Ensure that the given URL is a property file with the given property.
    
    Parameters:
    
    propertyFile - the name of the property file.
    
    property - the property.
    
    Returns:
    
    the validation status.

Class ShouldExtensions

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

shouldBeDate

shouldBeDate

shouldBeNumber

shouldBeNumber

shouldBeMavenVersion

shouldBeMavenVersion

shouldBeJavaRange

shouldBeAtLeastJava

shouldIterate

shouldIterate

shouldBeApiURL

shouldBe

shouldBe

shouldBe

shouldBe

shouldBe

shouldBeLiteral

shouldHaveDeprecatedMethod

shouldHaveMethod

shouldHaveMethod

shouldHaveMethods

shouldHaveMethods

shouldBeHiddenName

shouldHaveDeprecatedField

shouldHaveField

shouldHaveField

shouldExtend

shouldHaveNbMembers

shouldBe

shouldHaveProperty

shouldHaveProperty