InfoQ

Presentation

Recorded at:
Recorded at

How to Design a Good API & Why it Matters

Presented by Joshua Bloch on Nov 21, 2006 06:00 AM

Community
Architecture,
Java
Topics
Programming
Tags
JavaPolis
Summary
A well-written API can be a great asset to the organization that wrote it and to all that use it. Given the importance of good API design, surprisingly little has been written on the subject. In this talk (recorded at Javapolis), Java library designer Joshua Bloch teaches how to design good APIs, with many examples of what good and bad APIs look like.

Bio
Joshua Bloch is a Principal Engineer at Google. He led the design and implementation of numerous Java platform features, including the Java Collections Framework. He is the author of the Jolt Award-winning book Effective Java. He holds a Ph.D. in Computer Science from Carnegie-Mellon University and a B.S. in Computer Science from Columbia.

About the conference

Related Sponsor

The Adobe Flash Platform provides everything you need to develop applications, content and video across operating systems and devices.

20 comments

Watch Thread Reply

Excellent! by Rafael de F. Ferreira Posted Nov 23, 2006 1:03 PM
Re: Excellent! by jacky chen Posted Jun 14, 2007 9:55 PM
Verrrry Nice by Vinu Varghese Posted Nov 23, 2006 2:17 PM
Well worth taking the time to watch. by tanguy rademakers Posted Nov 23, 2006 5:21 PM
Excellent! by Gabriel Ka. Posted Nov 26, 2006 6:54 AM
Re: Excellent! by karan malhi Posted Nov 26, 2006 9:12 AM
Makes a lot of activities in your brain by Alex Krotov Posted Dec 2, 2006 12:13 AM
Any chance in making your videos available in some sort of offline format? by Jason Finch Posted Dec 18, 2006 1:59 AM
Re: Any chance in making your videos available in some sort of offline form by Oliver Gierke Posted Dec 19, 2006 2:52 AM
Re: Any chance in making your videos available in some sort of offline form by jacky chen Posted Jun 14, 2007 9:35 PM
How to Design a Good API & Why it Matters by Mike Vladi Posted Dec 24, 2006 3:15 PM
Re: How to Design a Good API Why it Matters should avalible offline by nazish ali Posted May 2, 2007 7:48 AM
We need VideoCasts by Luiz Alberto Silva Oliveira Posted Jun 11, 2007 12:02 PM
Clear explanation of designing a good API. by YoungHyun Kim Posted Sep 4, 2007 11:52 PM
Excellent - as always by Georges Polyzois Posted Sep 5, 2007 2:48 AM
Download presentation by jimens lima Posted Oct 1, 2008 9:56 AM
Re: Download presentation by Jirapong Nanta Posted Oct 11, 2008 12:33 AM
Good article by zhang bin Posted Mar 6, 2009 3:41 AM
I love this website by Jerome St-Pierre Posted May 23, 2009 9:01 AM
It's probably just me... by Dag Johansen Posted Jun 12, 2009 3:18 AM
Sort by date descending

  1. Back to top

    Excellent!

    Nov 23, 2006 1:03 PM by Rafael de F. Ferreira

    Best presentation I've seen in a while.

    Reply

  2. Back to top

    Verrrry Nice

    Nov 23, 2006 2:17 PM by Vinu Varghese

    Thanks for such a nice presentatiion

    Reply

  3. Back to top

    Well worth taking the time to watch.

    Nov 23, 2006 5:21 PM by tanguy rademakers

    A great presentation, both interesting and well presented. Thanks InfoQ.

    Reply

  4. Back to top

    Excellent!

    Nov 26, 2006 6:54 AM by Gabriel Ka.

    Sure to be not original at all but this presentation is excellent! Worth the time to watch.

    Reply

  5. Back to top

    Re: Excellent!

    Nov 26, 2006 9:12 AM by karan malhi

    Very good presentation

    Reply

  6. Back to top

    Makes a lot of activities in your brain

    Dec 2, 2006 12:13 AM by Alex Krotov

    Though I have 6 years of experience in Java field and more than half of advices/tips are already integrated in my head for long time, Joshua's presentation freshed my mind and revealed things I didn't consider closely. Thanks a lot for providing this video! It worth seeing twice if you're engaged in API (not only Java) design.

    Reply

  7. Back to top

    Any chance in making your videos available in some sort of offline format?

    Reply

  8. Back to top

    Some sort of podcast would be perfect... ;)

    Reply

  9. Back to top

    How to Design a Good API & Why it Matters

    Dec 24, 2006 3:15 PM by Mike Vladi

    Mr. Bloch = Clear thinking + PhD + Occam's razor approach.

    Reply

  10. Back to top

    This presentation clear my most of the points .because he addressed the very good points of an API design.I agree with Alex. This is not only JAVA . It's better to get it offline due to streaming prblms.

    Reply

  11. Back to top

    We need VideoCasts

    Jun 11, 2007 12:02 PM by Luiz Alberto Silva Oliveira

    I want to reforce the question about off-line videos, WE need it!!! Congratulations, the presentation is Excellent!

    Reply

  12. Back to top

    yes is very fun to listem such video ,i think its useful for listener

    Reply

  13. Back to top

    Re: Excellent!

    Jun 14, 2007 9:55 PM by jacky chen

    where i can download this video

    Reply

  14. Back to top

    Clear explanation of designing a good API.

    Sep 4, 2007 11:52 PM by YoungHyun Kim

    Actually, English is not my native language, but I could understand this presentation as he explained as well. Thanks Joshua & Thanks infoQ~!

    Reply

  15. Back to top

    Excellent - as always

    Sep 5, 2007 2:48 AM by Georges Polyzois

    Thanx for this excellent presentation - as always by Joshua B. Pleas can we have an offline version!!

    Reply

  16. Back to top

    Download presentation

    Oct 1, 2008 9:56 AM by jimens lima

    Where can i download presentation (ppt,pdf,...)?

    Reply

  17. Back to top

    Re: Download presentation

    Oct 11, 2008 12:33 AM by Jirapong Nanta

    Hi all, i just google around ... pdf can download at - http://lcsd05.cs.tamu.edu/slides/keynote.pdf Enjoy

    Reply

  18. Back to top

    Good article

    Mar 6, 2009 3:41 AM by zhang bin

    Good article

    Reply

  19. Back to top

    I love this website

    May 23, 2009 9:01 AM by Jerome St-Pierre

    I just watched this presentation 4 years later and everything said is still actual and not only for Java. This is why I love design so much. This man is a good speaker and I think these Javapolis events looks very cool, even if I am a .NET developer. Thanks for the high quality content, I never got so addicted to a website before.

    Reply

  20. Back to top

    It's probably just me...

    Jun 12, 2009 3:18 AM by Dag Johansen

    I don't get the idea with the ThreadLocal and the keys. Since Bloch is such a luminary I can only suppose that there is a good reason behind the design he came up with, but I can't see it. So, in the interest of learning, and I figure I may not be the only one who doesn't get it, I will simply ask and hope someone can enlighten me (us, if I am not alone in this).

    I do understand the issue with the string keys being "global namespace". Of course it's not really a namespace at all, but string comparison does mean different parts of the code could more easily overwrite one another's data. However, what is the point of using thread locals anyway? I thought the idea was to enable any object that participates in the work of a thread to easily share information *without* having to distribute a reference to anything all over the place. If so, replacing the string key with an object key negates the whole point of using thread locals in the first place.

    Furthermore, if I have to ensure all objects that need to access some data have a reference to the Key instance, isn't it just as easy then to instead ensure they have a reference to whatever is associated with that key?

    What is it that I have misunderstood or simply not understood?

    I don't want to risk this becoming a debate about whether Java or .net is better, but I have to say it seems to me the .net solution (in which one places a ThreadStatic attribute on a static field to indicate it should be stored as a thread-local variable) is rather better. It solves the problem of accidentally using the same variables where one meant to use different ones, requires extremely little code, is transparent to the user of the class declaring the static member (of course the field should be private and exposed via a property, but this changes none of what I've said), and does completely away with the need to write boilerplate code to obtain references to these objects. 

    public class Log
{
   [ThreadStatic]
   static Log current;

   static public Log Current 
   {
      get { return current; }
      set { current = value; }
   }

   // .... Log implementation
}


    Like this, whenever some operation starts that we'd like to log we'll simply create the log with 
    Log.Current = new Log();
    and then any code that is called in the context of a current log can obtain a reference to it with 
    Log log = Log.Current;
    or just use Log.Current.WriteLine() and so on directly.

    Reply

Educational Content

Bindings, Platforms, and Innovation

This presentation focuses on the Internet and separating myth from fact, history from the future, and the mundane from the imaginative. Bob Frankston presents a vision of what could and should be.

  •  Jul 02, 2009,
  •  

Orchestrating Long Running Activities with JBoss / JBPM

This article explores the use of JBoss and jBPM to implement design solutions that effectively address the issue of orchestrating long running activities.

  •  Jul 01, 2009,
  •  

Neo4j - The Benefits of Graph Databases

This presentation covers the use of graph databases as an optimal solution for data that is difficult to fit in static tables, rapidly evolving data or data that has a lot of optional attributes.

Realistic about Risk: Software development with Real Options

This session introduces Real Options and shows how it can help in running your project. Real Options is a decision-making process that can be used to manage risk.

  •  Jun 30, 2009,
  •  

Communication Flexibility Using Bindings

This article discusses the use of bindings on services and references (including the instance of non-configured bindings) as the means to implement SCA communications in a Web and SOA environment.

  •  Jun 30, 2009,
  •  

Writing DSLs in Groovy

After a short introduction to DSLs, Scott Davis plays with the keyboard showing how to approach the creation of a DSL by typing working snippets of Groovy code that get executed.

Scaling Agile with C/ALM (Collaborative Application Lifecycle Management)

IBM Rational and InfoQ present, Scaling Agile with C/ALM, an eBook showing organizations how to become “finely tuned software delivery machines” by enabling team integration and scaling.

Concurrent Programming with Microsoft F#

Amanda Laucher presents a real life enterprise application written in F#. She shows actual code snippets, explaining design decisions and suggesting how to use some of the F# constructs.