br.eti.kinoshita.testlinkjavaapi.util

Class Util

java.lang.Object

br.eti.kinoshita.testlinkjavaapi.util.Util

public final class Util
extends Object

Utility class with methods to handle the response or prepare the request to the PHP XML-RPC API. This class is able to convert from a Map to an Object and vice-versa.

Since:

1.9.0-1

Author:

Bruno P. Kinoshita - http://www.kinoshita.eti.br

Method Summary

Modifier and Type	Method and Description
static Object[]	castToArray(Object object)
static Map<String,Object>	castToMap(Object object)
static Object[]	getArray(Map<String,Object> map, String key)
static Attachment	getAttachment(Map<String,Object> map)
static Map<String,Object>	getAttachmentMap(Attachment attachment)
static Boolean	getBoolean(Map<String,Object> map, String key)
static Build	getBuild(Map<String,Object> map)
static Map<String,Object>	getBuildMap(Build build)
static CustomField	getCustomField(Map<String,Object> map)
static Execution	getExecution(Map<String,Object> map)
static Map<String,Object>	getExecutionAttachmentMap(Attachment attachment)
static Integer	getInteger(Map<String,Object> map, String key)
static Platform	getPlatform(Map<String,Object> map)
static ReportTCResultResponse	getReportTCResultResponse(Map<String,Object> map)
static Map<String,Object>	getRequirementAttachmentMap(Attachment attachment)
static List<Map<String,Object>>	getRequirementsGroupedByReqSpecMap(List<Requirement> requirements)
static Map<String,Object>	getRequirementSpecificationAttachmentMap(Attachment attachment)
static Role	getRole(Map<String,Object> map) Get a Role from a map with properties.
static String	getString(Map<String,Object> map, String key)
static String	getStringValueOrNull(Object o) Get the object string value, if not null.
static TestCase	getTestCase(Map<String,Object> map)
static Map<String,Object>	getTestCaseAttachmentMap(Attachment attachment)
static Map<String,Object>	getTestCaseMap(TestCase testCase)
static TestCaseStep	getTestCaseStep(Map<String,Object> map)
static Map<String,Object>	getTestCaseStepMap(TestCaseStep testCaseStep)
static Map<String,Object>	getTestCaseStepMap(TestCaseStep testCaseStep, boolean internal)
static List<Map<String,Object>>	getTestCaseStepResultMap(List<TestCaseStepResult> testCaseStepResults)
static List<Integer>	getTestCaseStepsIdList(List<TestCaseStep> testCaseSteps)
static List<Map<String,Object>>	getTestCaseStepsMap(List<TestCaseStep> testCaseSteps)
static TestPlan	getTestPlan(Map<String,Object> map)
static Map<String,Object>	getTestPlanMap(TestPlan plan)
static TestProject	getTestProject(Map<String,Object> map) Extracts a Test Project from a Map.
static Map<String,Object>	getTestProjectAttachmentMap(Attachment attachment)
static Map<String,Object>	getTestProjectMap(TestProject project)
static TestSuite	getTestSuite(Map<String,Object> map)
static Map<String,Object>	getTestSuiteAttachmentMap(Attachment attachment)
static Map<String,Object>	getTestSuiteMap(TestSuite testSuite)
static User	getUser(Map<String,Object> map) Get a User from a map with properties.
static void	putIfNotNull(Map<String,Object> map, String key, Object value) Puts a value into a map if the value is not null.
static void	putIfNotNullAndTrue(Map<String,Object> map, String key, Boolean boolValue) Puts a boolean value into a map if the value is not null.

Methods inherited from class java.lang.Object

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

Method Detail

getTestProjectMap

public static Map<String,Object> getTestProjectMap(TestProject project)

Parameters:

project - test project

Returns:

Map of Test Project

getTestProject

public static TestProject getTestProject(Map<String,Object> map)

Extracts a Test Project from a Map.

Parameters:

map - Map with properties of a Test Project.

Returns:

Test Project.

getBoolean

public static Boolean getBoolean(Map<String,Object> map,
                                 String key)

Parameters:

map - a map

key - the desired key

Returns:

Boolean value.

getString

public static String getString(Map<String,Object> map,
                               String key)

Parameters:

map - a map

key - the desired key

Returns:

String value.

getInteger

public static Integer getInteger(Map<String,Object> map,
                                 String key)

Parameters:

map - a map

key - the desired key

Returns:

Integer value.

getTestPlanMap

public static Map<String,Object> getTestPlanMap(TestPlan plan)

Parameters:

plan - test plan

Returns:

Map of Test Plan.

getTestPlan

public static TestPlan getTestPlan(Map<String,Object> map)

Parameters:

map - a map

Returns:

Test Plan.

getPlatform

public static Platform getPlatform(Map<String,Object> map)

Parameters:

map - a map

Returns:

Platform.

getTestCaseMap

public static Map<String,Object> getTestCaseMap(TestCase testCase)

Parameters:

testCase - test case

Returns:

Map of Test Case.

getTestCaseStepsMap

public static List<Map<String,Object>> getTestCaseStepsMap(List<TestCaseStep> testCaseSteps)

Parameters:

testCaseSteps - test case steps

Returns:

A list whit one Map for each TestCaseStep

Since:

1.9.4-1

getTestCaseStepsIdList

public static List<Integer> getTestCaseStepsIdList(List<TestCaseStep> testCaseSteps)

Parameters:

testCaseSteps - test case steps

Returns:

A list with the step's id

Since:

1.9.4-1

getTestCaseStep

public static TestCaseStep getTestCaseStep(Map<String,Object> map)

Parameters:

map - Case Step map

Returns:

Test Case

getTestCaseStepMap

public static Map<String,Object> getTestCaseStepMap(TestCaseStep testCaseStep)

Parameters:

testCaseStep - test case step

Returns:

Map of Test Case Step.

getTestCaseStepMap

public static Map<String,Object> getTestCaseStepMap(TestCaseStep testCaseStep,
                                                    boolean internal)

Parameters:

testCaseStep - test case step

internal - the API uses different names for the the same parameter in different methods.

Returns:

Map of Test Case Step.

getTestCaseStepResultMap

public static List<Map<String,Object>> getTestCaseStepResultMap(List<TestCaseStepResult> testCaseStepResults)

Parameters:

testCaseStepResults - test case steps

Returns:

A list with one Map for each TestCaseStepResult

Since:

1.9.19-0

getTestSuiteMap

public static Map<String,Object> getTestSuiteMap(TestSuite testSuite)

Parameters:

testSuite - test suite

Returns:

Map of Test Suite Map.

getTestSuite

public static TestSuite getTestSuite(Map<String,Object> map)

Parameters:

map - a map

Returns:

Test Suite.

getTestCase

public static TestCase getTestCase(Map<String,Object> map)

Parameters:

map - a map

Returns:

Test Case.

getArray

public static Object[] getArray(Map<String,Object> map,
                                String key)

Parameters:

map - a map

key - the desired key

Returns:

Array of objects.

castToArray

public static Object[] castToArray(Object object)

Parameters:

object - an object

Returns:

Array of objects

castToMap

public static Map<String,Object> castToMap(Object object)

Parameters:

object - an object

Returns:

Map of objects

getBuildMap

public static Map<String,Object> getBuildMap(Build build)

Parameters:

build - a build

Returns:

Map of Build.

getAttachmentMap

public static Map<String,Object> getAttachmentMap(Attachment attachment)

Parameters:

attachment - an attachment

Returns:

Map of Attachment.

getTestCaseAttachmentMap

public static Map<String,Object> getTestCaseAttachmentMap(Attachment attachment)

Parameters:

attachment - an attachment

Returns:

Map of Test Case Attachment.

getTestSuiteAttachmentMap

public static Map<String,Object> getTestSuiteAttachmentMap(Attachment attachment)

Parameters:

attachment - an attachment

Returns:

Map of Test Suite Attachment.

getTestProjectAttachmentMap

public static Map<String,Object> getTestProjectAttachmentMap(Attachment attachment)

Parameters:

attachment - an attachment

Returns:

Map of Test Project Attachment.

getRequirementAttachmentMap

public static Map<String,Object> getRequirementAttachmentMap(Attachment attachment)

Parameters:

attachment - an attachment

Returns:

Map of Requirement Attachment.

getRequirementSpecificationAttachmentMap

public static Map<String,Object> getRequirementSpecificationAttachmentMap(Attachment attachment)

Parameters:

attachment - an attachment

Returns:

Map of Requirement Specification Attachment.

getExecutionAttachmentMap

public static Map<String,Object> getExecutionAttachmentMap(Attachment attachment)

Parameters:

attachment - an attachment

Returns:

Map of Execution Attachment

getAttachment

public static Attachment getAttachment(Map<String,Object> map)

Parameters:

map - a map

Returns:

Attachment.

getRequirementsGroupedByReqSpecMap

public static List<Map<String,Object>> getRequirementsGroupedByReqSpecMap(List<Requirement> requirements)

Parameters:

requirements - list of requirements

Returns:

List with Maps of Requirements Grouped By ReSpec.

getExecution

public static Execution getExecution(Map<String,Object> map)

Parameters:

map - a map

Returns:

Execution.

getBuild

public static Build getBuild(Map<String,Object> map)

Parameters:

map - a map

Returns:

Build.

getReportTCResultResponse

public static ReportTCResultResponse getReportTCResultResponse(Map<String,Object> map)

Parameters:

map - a map

Returns:

ReportTCResultResponse object.

getCustomField

public static CustomField getCustomField(Map<String,Object> map)

Parameters:

map - a map

Returns:

Custom Field.

putIfNotNullAndTrue

public static void putIfNotNullAndTrue(Map<String,Object> map,
                                       String key,
                                       Boolean boolValue)

Puts a boolean value into a map if the value is not null.

Parameters:

map - Map.

key - Key.

boolValue - Boolean value.

putIfNotNull

public static void putIfNotNull(Map<String,Object> map,
                                String key,
                                Object value)

Puts a value into a map if the value is not null.

Parameters:

map - Map.

key - Key.

value - value.

getStringValueOrNull

public static String getStringValueOrNull(Object o)

Get the object string value, if not null.

Parameters:

o - object

Returns:

null if object is null, otherwise value of the toString method

getUser

public static User getUser(Map<String,Object> map)

Get a User from a map with properties.

Parameters:

map - map with properties

Returns:

a User

getRole

public static Role getRole(Map<String,Object> map)

Get a Role from a map with properties.

Parameters:

map - map with properties

Returns:

a Role