org.apache.wicket.model.ComponentModel.java Source code

Introduction

Here is the source code for org.apache.wicket.model.ComponentModel.java

Source

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (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.apache.org/licenses/LICENSE-2.0
 *
 * 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.
 */
package org.apache.wicket.model;

import org.apache.wicket.Component;

/**
 * Quick model that is implements the IComponentAssignedModel and the IModel interfaces. Its a quick
 * replacement for the current setObject(Component,Object) and getObject(Component) methods when the
 * component is needed in the model.
 * 
 * @author jcompagner
 * @param <T>
 *            type of model object
 */
public class ComponentModel<T> implements IModel<T>, IComponentAssignedModel<T> {
    private static final long serialVersionUID = 1L;

    /**
     * This getObject throws an exception.
     * 
     * @see org.apache.wicket.model.IModel#getObject()
     */
    @Override
    public final T getObject() {
        throw new RuntimeException("get object call not expected on a IComponentAssignedModel");
    }

    @Override
    public final void setObject(T object) {
        throw new RuntimeException("set object call not expected on a IComponentAssignedModel");
    }

    /**
     * Returns the object from the model with the use of the component where it is attached to.
     * 
     * @param component
     *            The component which has this model.
     * @return The object of the model.
     */
    protected T getObject(Component component) {
        return null;
    }

    /**
     * Sets the model object for this model.
     * 
     * @param component
     *            The component which has this model.
     * @param object
     *            The object that will be set in the model.
     */
    protected void setObject(Component component, T object) {
    }

    @Override
    public IWrapModel<T> wrapOnAssignment(Component comp) {
        return new WrapModel(comp);
    }

    private class WrapModel implements IWrapModel<T> {
        private static final long serialVersionUID = 1L;

        private final Component component;

        /**
         * @param comp
         */
        public WrapModel(Component comp) {
            component = comp;
        }

        @Override
        public IModel<T> getWrappedModel() {
            return ComponentModel.this;
        }

        @Override
        public T getObject() {
            return ComponentModel.this.getObject(component);
        }

        @Override
        public void setObject(T object) {
            ComponentModel.this.setObject(component, object);
        }

        @Override
        public void detach() {
            ComponentModel.this.detach();
        }
    }
}