Nice TWiki > Dev > NiceCasts (r1.18) TWiki webs:
Dev | Doc | Main | TWiki | Sandbox
Dev . { Changes | Index | Search | Go }
Here are some examples where I had to use cast or notNull in my project.
Daniel asked me to make this list in order to optimize the compiler.

OK, I'll try to clean up the cases where we have advanced, so that this page does not become incomprehensible. Please check you agree with the changes. -- Daniel


      JOptionPane.showMessageDialog(flowWindow,
         object("Errors in flow...."),
         "Error",
         JOptionPane.ERROR_MESSAGE);
flowWindow extends JInternalFrame

The second argument is supposed to be an Object in Java. Nice does not make value automatically subtypes of Object. You can use the object(...) function instead of cast(...) to do that.

For this kind of issue, I think the best is to use retyping. After checking the javadoc, one can see that the second argument can really be of any class. So we can declare:

< void showMessageDialog(Component parentComponent, T message, String title, int messageType)
  = native void JOptionPane.showMessageDialog(Component, Object, String, int);
After that, you should be able to call the method without cast not object(...).

Are you aware of the NiceSwing? project? This was done by Martin. It contains many retypings for java.awt, java.beans and javax.swing. It also has utility methods and classes, to do GUI stuff more easily, using Nice features like anonymous functions. At the moment, I think it is only available as a CVS module, but jars should be made at some point (a problem is that Martin is very busy at the moment). I just added some retypings for JOptionPane.

It would be interesting to see how that can help writing the GUI for flow4j. Also, related to the Eclipse plugin, a similar library could be done on top of SWT. -- DanielBonniot


      Rectangle rect = this.getHandlesBoundsRect();
      int width = cast(rect.getWidth());
      int height = cast(rect.getHeight());
getters return double

You should use:

      Rectangle rect = this.getHandlesBoundsRect();
      int width = int(rect.getWidth());
      int height = int(rect.getHeight());

int(...) in Nice is equivalent to (int) ... in Java. See http://nice.sourceforge.net/manual.html#conversion


   java.util.List<Handle> handles = new ArrayList();
   ...
      ConnectionHandle ch;
      ch = cast(handles.get(handles.size()-1));
ConnectionHandle extends Handle

How do you know that the last element has the right type? -- DanielBonniot

The draggable points of a Connection are Handles. The first and the last are connected to flowlets, thats why they are called ConnectionHandles, and the handles in between are EllbowHandles. There can be zero or more EllbowHandles?. I defined it like this. -- AlexGreif

Interesting. Here it is the logic of the system that guarantees the cast will not fail. I think you could take into account this logic in the types. One possibility is to keep a reference to the handles on both extremities in fields of type ConnectionHandle. If you wish, you can encapsulate the handles in a Handle class:

class Handles
{
  List<Handle> handles;
  ConnectionHandle first;
  CollectionHandle last;
}
// Some methods to manipulate handles.
--Main.DanielBonniot

Interesting too. But IMO not very nice design, because the class Figure (the super class of all) has the member List<Handle> handles. And I want to store all handles in one List. A Connection has this speciality that it has two types of handles. Besides this I can iterate easily if all Handles are in one List. -- AlexGreif

OK. Then could you add in Connection the two fields, while keeping everything in the list? -- Daniel

Then the info is redundant, and I have to update both. Where do I profit if I introduce two fields? -- Alex

The type information is not redundant. A benefit is that you make sure that there is no cast, that might fail at runtime in some strange condition. On the other hand, it is true that you then need to guarantee that the value in the field is the same as in the list. If you have a set method in the parent to build the list, then you could override it to set the fields when the index is 0 or length - 1, and the call super.

I agree that the benefit is discutable. An alternative is to use the cast. In a future version of Nice, I could imagine that you could do:

Hand h = cast(handles.get(handles.size()-1));
assert h instanceof ConnectionHandle;
// Now you can use h as a ConnectionHandle.


   public class ConnectionHandle extends Handle
      implements ConnectorListener
   {
      ...
   }

   java.util.List<ConnectionHandle> connectionHandles = this.getHandles().filter(asConnectionHandle);
   ConnectionHandle connectionHandle = connectionHandles.get(connectionHandleIndex);
   ?java.util.List<ConnectorListener> connectorListeners = conn.getConnectorListeners();
   if (connectorListeners != null  &&  notNull(connectorListeners).contains(connectionHandle)) {...}
In the last line I check the existence of a ConnectorListener in a List of ConnectorListeners. The local instance connectionHandle implements ConnectorListener.

The notNull should not be necessary, since Nice 0.7.8! :-) -- DanielBonniot

I compile with 0.7.8.
Without notNull the following error is reported

   [nicec] src/nice/flow4j/designer/figure/Connection.nice: line 211, column 80:
    [nicec] No possible call for contains.
    [nicec] Arguments: (?java.util.List<flow4j.designer.figure.ConnectorListener>, <t1691, U' | U' < nice.lang.Maybe> U'<t1691>)
    [nicec] Possibilities:
    [nicec] nice.lang.boolean contains(java.nio.charset.Charset, ?java.nio.charset.Charset)
    [nicec] nice.lang.boolean contains(flow4j.designer.figure.Handle this, Point)
    [nicec] nice.lang.boolean contains(flow4j.designer.figure.Figure this, Point)
    [nicec] nice.lang.boolean contains(flow4j.designer.figure.Connector this, Point)
    [nicec] nice.lang.boolean contains(java.awt.Component, ?java.awt.Point)
    [nicec] nice.lang.boolean contains(javax.accessibility.AccessibleRelationSet, ?java.lang.String)
    [nicec] nice.lang.boolean contains(javax.accessibility.AccessibleStateSet, ?javax.accessibility.AccessibleState)
    [nicec] nice.lang.boolean contains(javax.accessibility.AccessibleComponent, ?java.awt.Point)
    [nicec] nice.lang.boolean contains(java.awt.Polygon, ?java.awt.Point)
    [nicec] nice.lang.boolean contains(java.awt.Rectangle, ?java.awt.Rectangle)
    [nicec] nice.lang.boolean contains(java.awt.Rectangle, ?java.awt.Point)
    [nicec] nice.lang.boolean contains(java.awt.Shape, ?java.awt.geom.Point2D)
    [nicec] nice.lang.boolean contains(java.awt.Shape, ?java.awt.geom.Rectangle2D)
    [nicec] <Any K, Any V> nice.lang.boolean contains(java.util.Hashtable<K, V>, V)
    [nicec] <Any E> nice.lang.boolean contains(java.util.Collection<E>, E)
-- AlexGreif

With 0.7.8 I dont need the cast but need the notNull. If I leave the notNull off then the above problem is reported.

I'm surprised. You should not need notNull, because you test a local variable here. Can I have a self-contained testcase, please?


      ?Figure figure = getFrontFlowWindowDrawArea().getDrawing().getFigureExcept(
                  mousePos, this);
      if (figure == null)   return;
      Flowlet flowlet = cast(figure);
Flowlet extends Figure

The problem is now like with ConnectionHandle?. Could you modify the design a bit, so that the type of the expression is Flowlet and not Figure?

No. Figure is the superclass of all drawable Items. Flowlets are items that can be connected together. Connections cannot be connected. Thats why they are Figures.

Here is the class hierarchy:
Figure <- PolygonFigure
PolygonFigure <- Flowlet
PolygonFigure <- Connection
-- AlexGreif


          if (connectorListeners == null)   return;
      for (Iterator<ConnectorListener> iter = notNull(connectorListeners).iterator(); iter.hasNext();) {
         ConnectorListener ltnr = iter.next();
         
         if (figure.getHandles().contains(cast(ltnr))) {
            iter.remove();
            //println(" deleted: " + ltnr);
         }
      }
Isn't this code equivalent to the following -- ArjanB

I think Arjan is right, I will test it -- AlexGreif

          if (connectorListeners == null)   return;
      connectorListeners.removeAll(cast(figure.getHandles()));

You need notNull, because connectorListeners is not a local variable. This is explained in OptionTypes. A solution is there too.

What is the type of figure.getHandles() ?

   java.util.List<Handle> getHandles() = handles;

ConnectorHandle, that extends Handle implements ConnectorListener

Interesting. So you have a value of type A, a List<B> with B extends A, and you want to know if the value is in the list, right? We were discussing with Arjan if this is ever needed. The point is, it can only be true if the value is of type B. But now I can believe this is really useful.

If it is really this, we will change the type of contains in nice.lang. After that, you won't need this cast. -- DanielBonniot

I changed the retypings so the cast isn't needed anymore in the next DevelopmentVersion -- Arjan

Another example to show why contains should be contravariant.

<T,U,V | U <: T, V <: T> Set<T> intersection(Set<U>, Set<V>);

intersection<T,U,V>(s1@Set, s2@Set) {
   Set<T> res = new HashSet();
   if (s1.size() < s2.size()) {
       for(U elem : s1) 
           if (s2.contains(elem)) res.add(elem);
   } else {
       for(V elem : s2) 
           if (s1.contains(elem)) res.add(elem);
   }
   return res;
}
Should I reapply that patch then Daniel? -- ArjanB

OK! Doesn't removeAll also need to get a contravariant type? -- DanielBonniot

Yes but if I'm consistent then should almost all methods of the collection be retyped to get a co/contra-variant type. the methods in Map will get uglier retyping then.

<K, K0, V0, V | K <: K0, V <: ?V0> ?V0 get(java.util.Map<K, V>, K0) =
  native Object java.util.Map.get(Object);

Yes, it makes sense. JSR 14 (Java Generics) does use Object for the key in get. So we are still more strict and safe than them.

I don't think it matters too much if the retypings become more complicated, especially if it means they will be usable in more situations. -- Daniel

Ok but I'm not sure about one kind of retypings:

<K, K0, V | K <: K0> java.util.Set<K0> keySet(java.util.Map<K, V>) =
  native java.util.Set java.util.Map.keySet();

this is safe because a keyset is read/remove only. -- Arjan

Are you not sure it is safe, or if it is useful? I checked the javadoc, it is true that you cannot add elements, so this must be safe. I'm not sure how useful it will be, but it does not harm to do it. Maybe it will turn out useful in some situations. And we can say that Nice allows this, while Java 1.5 cannot! :-) -- Daniel

It reminds me that I still should write something about retyping, at least the is no shortage of examples -- ArjanB


   getFromConnection(state) {
      java.util.List<Connection> followings = this.getFromConnections();
      
      for (int i = 0; i < followings.size(); i++) {
         DecisionConnection connection = cast(followings.get(i));
         if (connection.getState() == state) {
            return connection;
         }
      }
      return null;
   }
DecisionConnection extends Connection

Why don't you declare that this.getFromConnections() returns a List<DecisionConnection>? -- DanielBonniot

The code above is in DecisionFlowlet, but this.getFromConnections() is declared in Flowlet that returns Connection objects.

Is getFromConnections reimplemented for DecisionFlowlet? -- DanielBonniot

No. Only implemented in Flowlet class. Thus I have to return a List with the lowest common denom.. --Main.AlexGreif

Should I use :

      java.util.List<DecisionConnection> followings = cast(this.getFromConnections());
-- AlexGreif

It's possible, but that's still a cast.

Note that using get on a List in a loop can be bad, in case the List is a linked list: you will traverse n**2 elements, instead of n. This is ideal for the new for syntax of version 0.7.8:

   getFromConnection(state) {
      java.util.List<DecisionConnection> followings = cast(this.getFromConnections());
      
      for (DecisionConnection connection : followings) {
         if (connection.getState() == state) {
            return connection;
         }
      }
      return null;
   }
-- DanielBonniot

OOps did I miss that? Is it documented somewhere? -- AlexGreif

I think it's in the changelog only, at the moment. You see, Arjan, documentation is needed! :-) -- DanielBonniot

It should be in the manual that you need to look in the changelog. ;-) -- ArjanB


more to come...

-- AlexGreif - 22 Apr 2003

OK, thanks. I'll treat them progressively.

For those that are solved, if you feel that some documentation should be added (for the numeric types, I updated the User manual, so that it compares with the Java syntax). After that they can be deleted.

Some will probably need to stay, when they are a good example of a typing problem, and how to solve it. So we can keep those there.

-- DanielBonniot - 22 Apr 2003

Topic NiceCasts . { Edit | Attach | Ref-By | Printable | Diffs | r1.24 | > | r1.23 | > | r1.22 | More }
Revision r1.18 - 23 Apr 2003 - 21:55 GMT - ArjanB
Parents: WebHome
Copyright © 1999-2003 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback.