com.liferay.portal.tools
Class ComparableRoute

java.lang.Object
  com.liferay.portal.tools.ComparableRoute

All Implemented Interfaces:

java.lang.Comparable<ComparableRoute>

public class ComparableRoute
extends java.lang.Object
implements java.lang.Comparable<ComparableRoute>

A dummy container for friendly URL route data used by source formatter. Implements the comparable interface to sort routes by increasing generality.

Author:

Connor McKay

Constructor Summary

ComparableRoute(java.lang.String pattern)

Method Summary

void	addGeneratedParameter(java.lang.String name, java.lang.String pattern)
void	addIgnoredParameter(java.lang.String name)
void	addImplicitParameter(java.lang.String name, java.lang.String value)
void	addOverriddenParameter(java.lang.String name, java.lang.String value)
int	compareTo(ComparableRoute comparableRoute)
boolean	equals(java.lang.Object obj)
java.util.Map<java.lang.String,java.lang.String>	getGeneratedParameters()
java.util.Set<java.lang.String>	getIgnoredParameters()
java.util.Map<java.lang.String,java.lang.String>	getImplicitParameters()
java.util.Map<java.lang.String,java.lang.String>	getOverriddenParameters()
java.lang.String	getPattern()
static boolean	hasRegex(java.lang.String fragment)
static boolean	isCaptureFragment(java.lang.String fragment)
static boolean	isMatchAny(java.lang.String fragment)

Methods inherited from class java.lang.Object

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

Constructor Detail

ComparableRoute

public ComparableRoute(java.lang.String pattern)

Method Detail

hasRegex

public static boolean hasRegex(java.lang.String fragment)

isCaptureFragment

public static boolean isCaptureFragment(java.lang.String fragment)

isMatchAny

public static boolean isMatchAny(java.lang.String fragment)

addGeneratedParameter

public void addGeneratedParameter(java.lang.String name,
                                  java.lang.String pattern)

addIgnoredParameter

public void addIgnoredParameter(java.lang.String name)

addImplicitParameter

public void addImplicitParameter(java.lang.String name,
                                 java.lang.String value)

addOverriddenParameter

public void addOverriddenParameter(java.lang.String name,
                                   java.lang.String value)

compareTo

public int compareTo(ComparableRoute comparableRoute)

Specified by:

compareTo in interface java.lang.Comparable<ComparableRoute>

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getGeneratedParameters

public java.util.Map<java.lang.String,java.lang.String> getGeneratedParameters()

getIgnoredParameters

public java.util.Set<java.lang.String> getIgnoredParameters()

getImplicitParameters

public java.util.Map<java.lang.String,java.lang.String> getImplicitParameters()

getOverriddenParameters

public java.util.Map<java.lang.String,java.lang.String> getOverriddenParameters()

getPattern

public java.lang.String getPattern()