InfoQ

InfoQ

Presentation

My Bookmarks

Login or Register to enable bookmarks for unlimited time.

The content has been bookmarked!

There was an error bookmarking this content! Please retry.

Recorded at:
Recorded at

How to Design a Good API & Why it Matters

Presented by Joshua Bloch on Nov 21, 2006 Length 01:09:11
Sections
Development,
Architecture & Design
Topics
Java ,
Architecture ,
Programming
Tags
JavaPolis
 

How would you like to view the presentation?

In case you are having issues watching this video, please follow these simple steps to help us investigate the issue:
1. Right click on the video player and select Copy log
2. Paste the copied information in an email to video-issue@infoq.com (clicking this link will fill in the default details in most email clients).
Note: in case your email client hasn't automatically picked up the email subject, please include in your email the URL of the video too.
3. Done.
We will investigate the issue and get back to you as soon as possible. Thanks for helping us improve our site!
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

20 comments

Watch Thread Reply

Excellent! by Rafael de F. Ferreira Posted
Re: Excellent! by chen jacky Posted
Verrrry Nice by Vinu Varghese Posted
Well worth taking the time to watch. by tanguy rademakers Posted
Excellent! by Gabriel Kastenbaum Posted
Re: Excellent! by karan malhi Posted
Makes a lot of activities in your brain by Alex Krotov Posted
Any chance in making your videos available in some sort of offline format? by Jason F Posted
Re: Any chance in making your videos available in some sort of offline form by Oliver Gierke Posted
Re: Any chance in making your videos available in some sort of offline form by chen jacky Posted
How to Design a Good API & Why it Matters by Mikhail Vladimirov Posted
Re: How to Design a Good API Why it Matters should avalible offline by nazish ali Posted
We need VideoCasts by Luiz Alberto Silva Oliveira Posted
Clear explanation of designing a good API. by YoungHyun Kim Posted
Excellent - as always by Georges Polyzois Posted
Download presentation by jimens lima Posted
Re: Download presentation by Jirapong Nanta Posted
Good article by bin zhang Posted
I love this website by Jerome St-Pierre Posted
It's probably just me... by Dag Johansen Posted
  1. Back to top

    Excellent!

    by Rafael de F. Ferreira

    Best presentation I've seen in a while.

  2. Back to top

    Verrrry Nice

    by Vinu Varghese

    Thanks for such a nice presentatiion

  3. Back to top

    Well worth taking the time to watch.

    by tanguy rademakers

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

  4. Back to top

    Excellent!

    by Gabriel Kastenbaum

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

  5. Back to top

    Re: Excellent!

    by karan malhi

    Very good presentation

  6. Back to top

    Makes a lot of activities in your brain

    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.

  7. Back to top

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

    by Jason F

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

  8. Back to top

    Re: Any chance in making your videos available in some sort of offline form

    by Oliver Gierke

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

  9. Back to top

    How to Design a Good API & Why it Matters

    by Mikhail Vladimirov

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

  10. Back to top

    Re: How to Design a Good API Why it Matters should avalible offline

    by nazish ali

    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.

  11. Back to top

    We need VideoCasts

    by Luiz Alberto Silva Oliveira

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

  12. Back to top

    Re: Any chance in making your videos available in some sort of offline form

    by chen jacky

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

  13. Back to top

    Re: Excellent!

    by chen jacky

    where i can download this video

  14. Back to top

    Clear explanation of designing a good API.

    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~!

  15. Back to top

    Excellent - as always

    by Georges Polyzois

    Thanx for this excellent presentation - as always by Joshua B.

    Pleas can we have an offline version!!

  16. Back to top

    Download presentation

    by jimens lima

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

  17. Back to top

    Re: Download presentation

    by Jirapong Nanta

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

    Enjoy

  18. Back to top

    Good article

    by bin zhang

    Good article

  19. Back to top

    I love this website

    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.

  20. Back to top

    It's probably just me...

    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.

Educational Content

Questions for an Enterprise Architect

Erik Dörnenburg answers: What is Enterprise and Evolutionary Architecture?, discussing 4 issues: Turning strategy into execution, Ensuring conformance, Where do the architects sit? Buying or building?

Wrap Your SQL Head Around Riak MapReduce

Sean Cribbs explains what Map-Reduce and Riak are, why and how to use Map-Reduce with Riak, and how to convert SQL queries into their Map-Reduce equivalents.

Polyglot Persistence for Java Developers - Moving Out of the Relational Comfort Zone

Chris Richardson shows how he ported a relational database to three NoSQL data stores: Redis, Cassandra and MongoDB.

The Golden Circle – Why How What

Jean Tabaka challenges the audience to reflect on what Agile practices they are employing, how they are using them, ending with the questions “Why have their organization chosen to go Agile?

The Web Platform as a Limitless Pool of Innovation, with Andreas Gal

Andreas talks about the benefits of the Open Web and how it compares to proprietary stacks. He also talks about various projects that push the envelope like Boot to Gecko, Broadway and pdf.js.

Hadoop and NoSQLin a Big Data Environment

Ron Bodkin discusses early adoption of Hadoop, NoSQL and describes MapReduce and related libraries and Frameworks. Other topics include Hive, Pig, multi tenancy, and security in a big data environment

Spring and Platform Interoperability

Stephen Bohlen explains how Spring helps with interoperability between Java and .NET, demoing it with the help of a sample application.

How to Stop Writing Next Year's Unsustainable Piece of Code

Guilherme Silveira mentions some of the turning points in project development that may affect the quality of the code offering advice on avoiding writing crappy code.