KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > ubermq > jms > common > routing > SourceDescriptor


1 /*
2  * Copyright (c) 2004 Rhombus Technologies, Inc.
3  * All rights reserved.
4  */

5 package com.ubermq.jms.common.routing;
6
7 /**
8  * Describes a source. This is used by <code>SourceSpec</code> implementations to
9  * match incoming arguments.
10  * <p>
11  *
12  * A source descriptor's <code>equals</code> method may only return <code>true</code>
13  * if and only if the results of <code>getMatchValue</code> are also equal. This restriction
14  * is necessary for optimal performance.
15  */

16 public interface SourceDescriptor
17 {
18     /**
19      * @return a human readable name for this destination.
20      */

21     public String JavaDoc getDisplayName();
22     
23     /**
24      * The actual value that can be used for matching. Other implementations
25      * may provide more information, but this is primary value that should be provided at a minimum.
26      *
27      * @return the value used to match.
28      */

29     public String JavaDoc getMatchValue();
30 }
31
Popular Tags