Package ca.uhn.fhir.util

Class ParametersUtil

java.lang.Object

ca.uhn.fhir.util.ParametersUtil

public class ParametersUtil
extends Object

Utilities for dealing with parameters resources in a version indepenedent way

Constructor Summary

Constructors

Constructor	Description
ParametersUtil()

Method Summary

Modifier and Type	Method	Description
static IBase	addParameterToParameters(FhirContext theContext, IBaseParameters theParameters, String theName)	Add a parameter with no value (typically because we'll be adding sub-parameters)
static void	addParameterToParameters(FhirContext theContext, IBaseParameters theParameters, String theName, Object theValue)	Add a parameter value to a Parameters resource
static void	addParameterToParameters(FhirContext theContext, IBaseParameters theParameters, String theName, String thePrimitiveDatatype, String theValue)	Add a parameter value to a Parameters resource
static void	addParameterToParametersBoolean(FhirContext theCtx, IBaseParameters theParameters, String theName, boolean theValue)
static void	addParameterToParametersCode(FhirContext theCtx, IBaseParameters theParameters, String theName, String theValue)
static void	addParameterToParametersDecimal(FhirContext theCtx, IBaseParameters theParameters, String theName, BigDecimal theValue)
static void	addParameterToParametersInteger(FhirContext theCtx, IBaseParameters theParameters, String theName, int theValue)
static void	addParameterToParametersLong(FhirContext theCtx, IBaseParameters theParameters, String theName, long theValue)
static void	addParameterToParametersReference(FhirContext theCtx, IBaseParameters theParameters, String theName, String theReference)
static void	addParameterToParametersString(FhirContext theCtx, IBaseParameters theParameters, String theName, String theValue)
static void	addParameterToParametersUri(FhirContext theCtx, IBaseParameters theParameters, String theName, String theValue)
static IBase	addPart(FhirContext theContext, IBase theParameter, String theName, IBase theValue)
static void	addPartBoolean(FhirContext theContext, IBase theParameter, String theName, Boolean theValue)
static void	addPartCode(FhirContext theContext, IBase theParameter, String theName, String theCode)
static void	addPartCoding(FhirContext theContext, IBase theParameter, String theName, String theSystem, String theCode, String theDisplay)
static void	addPartDecimal(FhirContext theContext, IBase theParameter, String theName, Double theValue)
static void	addPartInteger(FhirContext theContext, IBase theParameter, String theName, Integer theInteger)
static void	addPartResource(FhirContext theContext, IBase theParameter, String theName, IBaseResource theValue)
static void	addPartString(FhirContext theContext, IBase theParameter, String theName, String theValue)
static void	addPartUrl(FhirContext theContext, IBase theParameter, String theName, String theCode)
static IPrimitiveType<?>	createCode(FhirContext theContext, String theValue)
static IBase	createPart(FhirContext theContext, IBase thePart, String theName)
static IPrimitiveType<?>	createString(FhirContext theContext, String theValue)
static IPrimitiveType<?>	createUri(FhirContext theContext, String theValue)
static String	extractDescription(Description desc)
static String	extractDescription(Annotation[] theParameterAnnotations)
static String	extractDescription(AnnotatedElement theType)
static List<String>	extractExamples(Annotation[] theParameterAnnotations)
static String	extractShortDefinition(AnnotatedElement theType)
static Optional<IBase>	getNamedParameter(FhirContext theCtx, IBaseResource theParameters, String theParameterName)
static List<String>	getNamedParameterPartAsString(FhirContext theCtx, IBaseParameters theParameters, String thePartName, String theParameterName)
static Optional<IBaseResource>	getNamedParameterResource(FhirContext theCtx, IBaseParameters theParameters, String theParameterName)	Returns the resource within a parameter.
static List<IBase>	getNamedParameters(FhirContext theCtx, IBaseResource theParameters, String theParameterName)
static Optional<Integer>	getNamedParameterValueAsInteger(FhirContext theCtx, IBaseParameters theParameters, String theParameterName)
static Optional<String>	getNamedParameterValueAsString(FhirContext theCtx, IBaseParameters theParameters, String theParameterName)
static List<Integer>	getNamedParameterValuesAsInteger(FhirContext theCtx, IBaseParameters theParameters, String theParameterName)
static List<String>	getNamedParameterValuesAsString(FhirContext theCtx, IBaseParameters theParameters, String theParameterName)
static Optional<IBase>	getParameterPart(FhirContext theCtx, IBase theParameter, String theParameterName)
static Optional<IBase>	getParameterPartValue(FhirContext theCtx, IBase theParameter, String theParameterName)
static Optional<Integer>	getParameterPartValueAsInteger(FhirContext theCtx, IBase theParameter, String theParameterName)
static String	getParameterPartValueAsString(FhirContext theCtx, IBase theParameter, String theParameterName)
static IBaseParameters	newInstance(FhirContext theContext)

Methods inherited from class java.lang.Object

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

Constructor Details

ParametersUtil

public ParametersUtil()

Method Details

getNamedParameterValueAsString

public static Optional<String> getNamedParameterValueAsString(FhirContext theCtx,
 IBaseParameters theParameters,
 String theParameterName)

getNamedParameterValuesAsString

public static List<String> getNamedParameterValuesAsString(FhirContext theCtx,
 IBaseParameters theParameters,
 String theParameterName)

getNamedParameterValuesAsInteger

public static List<Integer> getNamedParameterValuesAsInteger(FhirContext theCtx,
 IBaseParameters theParameters,
 String theParameterName)

getNamedParameterValueAsInteger

public static Optional<Integer> getNamedParameterValueAsInteger(FhirContext theCtx,
 IBaseParameters theParameters,
 String theParameterName)

getNamedParameterResource

public static Optional<IBaseResource> getNamedParameterResource(FhirContext theCtx,
 IBaseParameters theParameters,
 String theParameterName)

Returns the resource within a parameter.

Parameters:

theCtx - thr FHIR context

theParameters - the parameters instance where to look for the resource

theParameterName - the parameter name

Returns:

the resource

getNamedParameter

public static Optional<IBase> getNamedParameter(FhirContext theCtx,
 IBaseResource theParameters,
 String theParameterName)

getNamedParameters

public static List<IBase> getNamedParameters(FhirContext theCtx,
 IBaseResource theParameters,
 String theParameterName)

getParameterPart

public static Optional<IBase> getParameterPart(FhirContext theCtx,
 IBase theParameter,
 String theParameterName)

getParameterPartValue

public static Optional<IBase> getParameterPartValue(FhirContext theCtx,
 IBase theParameter,
 String theParameterName)

getParameterPartValueAsString

public static String getParameterPartValueAsString(FhirContext theCtx,
 IBase theParameter,
 String theParameterName)

getParameterPartValueAsInteger

public static Optional<Integer> getParameterPartValueAsInteger(FhirContext theCtx,
 IBase theParameter,
 String theParameterName)

addParameterToParameters

public static void addParameterToParameters(FhirContext theContext,
 IBaseParameters theParameters,
 String theName,
 Object theValue)

Add a parameter value to a Parameters resource

Parameters:

theContext - The FhirContext

theParameters - The Parameters resource

theName - The parameter name

theValue - The parameter value (can be a resource or a datatype)

addParameterToParameters

public static void addParameterToParameters(FhirContext theContext,
 IBaseParameters theParameters,
 String theName,
 String thePrimitiveDatatype,
 String theValue)

Add a parameter value to a Parameters resource

Parameters:

theContext - The FhirContext

theParameters - The Parameters resource

theName - The parameter name

thePrimitiveDatatype - The datatype, e.g. "string", or "uri"

theValue - The value

createString

public static IPrimitiveType<?> createString(FhirContext theContext,
 String theValue)

createUri

public static IPrimitiveType<?> createUri(FhirContext theContext,
 String theValue)

createCode

public static IPrimitiveType<?> createCode(FhirContext theContext,
 String theValue)

newInstance

public static IBaseParameters newInstance(FhirContext theContext)

addParameterToParametersBoolean

public static void addParameterToParametersBoolean(FhirContext theCtx,
 IBaseParameters theParameters,
 String theName,
 boolean theValue)

addParameterToParametersCode

public static void addParameterToParametersCode(FhirContext theCtx,
 IBaseParameters theParameters,
 String theName,
 String theValue)

addParameterToParametersInteger

public static void addParameterToParametersInteger(FhirContext theCtx,
 IBaseParameters theParameters,
 String theName,
 int theValue)

addParameterToParametersLong

public static void addParameterToParametersLong(FhirContext theCtx,
 IBaseParameters theParameters,
 String theName,
 long theValue)

addParameterToParametersDecimal

public static void addParameterToParametersDecimal(FhirContext theCtx,
 IBaseParameters theParameters,
 String theName,
 BigDecimal theValue)

addParameterToParametersReference

public static void addParameterToParametersReference(FhirContext theCtx,
 IBaseParameters theParameters,
 String theName,
 String theReference)

addParameterToParametersString

public static void addParameterToParametersString(FhirContext theCtx,
 IBaseParameters theParameters,
 String theName,
 String theValue)

addParameterToParametersUri

public static void addParameterToParametersUri(FhirContext theCtx,
 IBaseParameters theParameters,
 String theName,
 String theValue)

addParameterToParameters

public static IBase addParameterToParameters(FhirContext theContext,
 IBaseParameters theParameters,
 String theName)

Add a parameter with no value (typically because we'll be adding sub-parameters)

addPartCode

public static void addPartCode(FhirContext theContext,
 IBase theParameter,
 String theName,
 String theCode)

addPartInteger

public static void addPartInteger(FhirContext theContext,
 IBase theParameter,
 String theName,
 Integer theInteger)

addPartString

public static void addPartString(FhirContext theContext,
 IBase theParameter,
 String theName,
 String theValue)

addPartUrl

public static void addPartUrl(FhirContext theContext,
 IBase theParameter,
 String theName,
 String theCode)

addPartBoolean

public static void addPartBoolean(FhirContext theContext,
 IBase theParameter,
 String theName,
 Boolean theValue)

addPartDecimal

public static void addPartDecimal(FhirContext theContext,
 IBase theParameter,
 String theName,
 Double theValue)

addPartCoding

public static void addPartCoding(FhirContext theContext,
 IBase theParameter,
 String theName,
 String theSystem,
 String theCode,
 String theDisplay)

addPart

public static IBase addPart(FhirContext theContext,
 IBase theParameter,
 String theName,
 @Nullable
 IBase theValue)

createPart

public static IBase createPart(FhirContext theContext,
 IBase thePart,
 String theName)

addPartResource

public static void addPartResource(FhirContext theContext,
 IBase theParameter,
 String theName,
 IBaseResource theValue)

getNamedParameterPartAsString

public static List<String> getNamedParameterPartAsString(FhirContext theCtx,
 IBaseParameters theParameters,
 String thePartName,
 String theParameterName)

extractDescription

@Nullable
public static String extractDescription(AnnotatedElement theType)

extractDescription

@Nullable
public static String extractDescription(Description desc)

extractShortDefinition

@Nullable
public static String extractShortDefinition(AnnotatedElement theType)

extractDescription

public static String extractDescription(Annotation[] theParameterAnnotations)

extractExamples

public static List<String> extractExamples(Annotation[] theParameterAnnotations)