Skip to content

class RoutePattern

cangjie
public class RoutePattern

功能:表示解析后的路由模式。

成员概览

成员功能
var displayText用于显示的路由 URL 文本。
prop requiredValueAny返回 requiredValues 中表示任意非空值的哨兵值。
prop rawText返回原始路由模板文本。
prop defaults返回路由参数默认值字典。
prop parameterPolicies返回路由参数策略字典。
prop requiredValues返回路由必需值字典。
prop parameters返回路由中定义的参数片段列表。
prop pathSegments返回路由的路径段列表。
prop inboundPrecedence返回路由的入站优先级。
prop outboundPrecedence返回路由的出站优先级。
func isRequiredValueAny(?String)检查给定值是否为 RequiredValueAny 哨兵。
func getParameter(String)按名称查找路由参数片段。

var displayText

cangjie
public var displayText: ?String = None

功能:用于显示的路由 URL 文本。

类型:?String

prop requiredValueAny

cangjie
public static prop requiredValueAny: String

功能:返回 requiredValues 中表示任意非空值的哨兵值。

类型:String

prop rawText

cangjie
public prop rawText: String

功能:返回原始路由模板文本。

类型:String

prop defaults

cangjie
public prop defaults: ReadOnlyMap<String, ?String>

功能:返回路由参数默认值字典。

类型:ReadOnlyMap<String, ?String>

prop parameterPolicies

cangjie
public prop parameterPolicies: ReadOnlyMap<String, ReadOnlyList<RoutePatternParameterPolicyReference>>

功能:返回路由参数策略字典。

类型:ReadOnlyMap<String, ReadOnlyList<RoutePatternParameterPolicyReference>>

prop requiredValues

cangjie
public prop requiredValues: ReadOnlyMap<String, ?String>

功能:返回路由必需值字典。

类型:ReadOnlyMap<String, ?String>

prop parameters

cangjie
public prop parameters: ReadOnlyList<RoutePatternParameterPart>

功能:返回路由中定义的参数片段列表。

类型:ReadOnlyList<RoutePatternParameterPart>

prop pathSegments

cangjie
public prop pathSegments: ReadOnlyList<RoutePatternPathSegment>

功能:返回路由的路径段列表。

类型:ReadOnlyList<RoutePatternPathSegment>

prop inboundPrecedence

cangjie
public prop inboundPrecedence: Decimal

功能:返回路由的入站优先级。

类型:Decimal

prop outboundPrecedence

cangjie
public prop outboundPrecedence: Decimal

功能:返回路由的出站优先级。

类型:Decimal

func isRequiredValueAny(?String)

cangjie
public static func isRequiredValueAny(value: ?String): Bool

功能:检查给定值是否为 RequiredValueAny 哨兵。

参数:

  • value: ?String - 待判断的 required value。

返回值:

  • Bool - 若为哨兵字符串返回 true,否则返回 false。

func getParameter(String)

cangjie
public func getParameter(name: String): ?RoutePatternParameterPart

功能:按名称查找路由参数片段。

参数:

  • name: String - 参数名称。

返回值: