/*
 Copyright (C) 2009 Ueli Hofstetter

 This source code is release under the BSD License.

 This file is part of JQuantLib, a free-software/open-source library
 for financial quantitative analysts and developers - http://jquantlib.org/

 JQuantLib is free software: you can redistribute it and/or modify it
 under the terms of the JQuantLib license.  You should have received a
 copy of the license along with this program; if not, please email
 . The license is also available online at
 .

 This program is distributed in the hope that it will be useful, but WITHOUT
 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 FOR A PARTICULAR PURPOSE.  See the license for more details.

 JQuantLib is based on QuantLib. http://quantlib.org/
 When applicable, the original copyright notice follows this notice.
 */

package org.jquantlib.cashflow;

import org.jquantlib.QL;
import org.jquantlib.quotes.Handle;
import org.jquantlib.termstructures.SwaptionVolatilityStructure;

/**
 * Base pricer for vanilla CMS coupons
 *
 * @author Ueli Hofstetter
 */
// TODO: code review :: license, class comments, comments for access modifiers, comments for @Override
public abstract class CmsCouponPricer extends FloatingRateCouponPricer {

    private Handle swaptionVol_;
    private static final String no_adequate_swaptionVol_given = "no adequate swaptionVol given";

    public CmsCouponPricer(final Handle swaptionVol) {
        this.swaptionVol_ = swaptionVol;
        this.swaptionVol_.addObserver(this);
        //XXX:registerWith
        //registerWith(this.swaptionVol_);
    }

    public Handle swaptionVolatility() {
        return swaptionVol_;
    }

    public void setSwaptionVolatility(final Handle swaptionVol) {
        swaptionVol.currentLink().deleteObserver(this);
        //XXX:registerWith
        //unregisterWith(swaptionVol);

        this.swaptionVol_ = swaptionVol;
        QL.require(swaptionVol_!=null && swaptionVol_.currentLink() != null , no_adequate_swaptionVol_given); // TODO: message

        this.swaptionVol_.addObserver(this);
        //registerWith(swaptionVol_);
        update();
    }


    //
    // implements Observer
    //

    @Override
    //TODO: code review
    public void update() {
        notifyObservers();
    }

}