Question

I’m exploring a large Java library, and came across this code. I’m wondering what the @Override is for, along with the # symbol in the comments.

Is this an incomplete function? It looks like that since it returns false always.

/* (non-Javadoc)
 * @see cascadas.supervision.components.SensorDataReady#evaluate(cascadas.ace.event.Event, cascadas.ace.session.Contract, cascadas.ace.session.Session, cascadas.ace.session.Session)
 */
@Override
public boolean evaluate(Event inputMessage, Contract contract,
        Session executionSession, Session globalSession) {
    // TODO Auto-generated method stub
    return false;
}

I appreciate any tips.

Answer 1

For what the pound (#) means, see the documentation for the @see Javadoc tag. It basically designates a package.class#member.

The (non-Javadoc) part designates that this method will inherit its Javadoc from the Javadoc of one of its superclasses. The method comment is basically directing you to SensorDataReady#evaluate for this method’s Javadoc.

@Override is an annotation. See its Javadoc.

As for the method itself, it looks like Eclipse-generated code. Eclipse puts the TODO comment there to remind a developer to implement the overridden method.