+Show TOC
×Hide TOC

IAccessor

Kind of class:	interface
Inherits from:	none
Implemented by:	MethodAccessor MultiAccessor PropertyAccessor
Version:	1.0
Author:	Francis Bourre
Classpath:	com.bourre.core.IAccessor
File last modified:	Wednesday, 31 October 2007, 07:35:29

► View source

▼ Hide source

/*
 * Copyright the original author or authors.
 * 
 * Licensed under the MOZILLA PUBLIC LICENSE, Version 1.1 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.mozilla.org/MPL/MPL-1.1.html
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
/**
 * {@code IAccessor} defines basic rules for {@code setter} implementation.
 * 
 * <p>Take a look at {@link com.bourre.core} package to see {@code IAccessor} 
 * implementations.
 * 
 * @author Francis Bourre
 * @version 1.0 
 */

interface com.bourre.core.IAccessor 
{
    /**
     * Returns current value targeted by the setter.
     * 
     * @return value
     */
    public function getValue();
    
    /**
     * Sets passed-in value to object using setter function defined 
     * during concrete instanciation.
     * 
     * @param value value to set
     */
    public function setValue( value ) : Void;
    
    /**
     * Returns object targeted by current setter.
     * 
     * @return instance
     */
    public function getTarget();
    
    /**
     * Returns method or property used by current getter to retrieve object value.
     * 
     * @return {@code String} property or {@code Function}
     */
    public function getGetterHelper();
    
    /**
     * Returns method or property used by current setter to modify object value.
     * 
     * @return {@code String} property or {@code Function}
     */
    public function getSetterHelper();
}

IAccessor defines basic rules for setter implementation.

Take a look at com.bourre.core package to see IAccessor
implementations.

Summary

Instance methods

getValue
setValue
getTarget
getGetterHelper
getSetterHelper

Instance methods

getGetterHelper

function getGetterHelper (

)

Returns method or property used by current getter to retrieve object value.

Returns:

String property or Function

getSetterHelper

function getSetterHelper (

)

Returns method or property used by current setter to modify object value.

Returns:

String property or Function

getTarget

function getTarget (

)

Returns object targeted by current setter.

Returns:

instance

getValue

function getValue (

)

Returns current value targeted by the setter.

Returns:

value

setValue

function setValue (

) : Void

Sets passed-in value to object using setter function defined
during concrete instanciation.

Parameters:

value:

value to set