View Javadoc
1 /* 2 * Scope: a generic MVC framework. 3 * Copyright (c) 2000-2002, The Scope team 4 * All rights reserved. 5 * 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 11 * Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 14 * Redistributions in binary form must reproduce the above copyright 15 * notice, this list of conditions and the following disclaimer in the 16 * documentation and/or other materials provided with the distribution. 17 * 18 * Neither the name "Scope" nor the names of its contributors 19 * may be used to endorse or promote products derived from this software 20 * without specific prior written permission. 21 * 22 * 23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 26 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR 27 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 28 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 29 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 30 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 31 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 32 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 33 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 34 * 35 * 36 * $Id: StringIndexSelector.java,v 1.4 2002/09/05 15:41:45 ludovicc Exp $ 37 */ 38 package org.scopemvc.core; 39 40 41 /*** 42 * <P> 43 * 44 * An implementation of {@link Selector} that identifies a property by its 45 * <CODE>String</CODE> index within the parent model object. </P> <P> 46 * 47 * Create by {@link Selector#fromString(String)}. </P> 48 * 49 * @author <A HREF="mailto:smeyfroi@users.sourceforge.net">Steve Meyfroidt</A> 50 * @created 05 August 2002 51 * @version $Revision: 1.4 $ $Date: 2002/09/05 15:41:45 $ 52 */ 53 public final class StringIndexSelector extends Selector { 54 55 /*** 56 * The <CODE>String</CODE> index of the selected property. Immutable after 57 * construction. 58 */ 59 private String index; 60 61 62 /*** 63 * Package private for factory to create. 64 * 65 * @param inIndex The index (name) of the property to select 66 */ 67 StringIndexSelector(String inIndex) { 68 setIndex(inIndex); 69 } 70 71 72 /*** 73 * Gets the index (i.e the name of the property selected) 74 * 75 * @return The index value 76 * @see #getName 77 */ 78 public final String getIndex() { 79 return index; 80 } 81 82 83 /*** 84 * Gets the name of the property selected 85 * 86 * @return The name value 87 */ 88 public final String getName() { 89 return getIndex(); 90 } 91 92 93 /*** 94 * Sets the index 95 * 96 * @param inIndex The new index value 97 */ 98 public void setIndex(String inIndex) { 99 index = inIndex; 100 } 101 102 103 /*** 104 * Returns the hashCode 105 * 106 * @return the hashCode of this object 107 */ 108 public int hashCode() { 109 return index.hashCode(); 110 } 111 112 113 /*** 114 * Creates a shallow copy of this selector 115 * 116 * @return a shallow copy of this selector 117 */ 118 protected Selector getShallowCopy() { 119 return new StringIndexSelector(index); 120 } 121 122 123 /*** 124 * Returns true if this Selector is equals to the given Selector when 125 * omitting the chained Selectors 126 * 127 * @param inSelector Another Selector to test against 128 * @return true if we have shallow equality 129 */ 130 protected final boolean shallowEquals(Selector inSelector) { 131 if (!(inSelector instanceof StringIndexSelector)) { 132 return false; 133 } 134 return getIndex().equals(((StringIndexSelector) inSelector).getIndex()); 135 } 136 } 137

This page was automatically generated by Maven